Skip to main content
GET
/
v1
/
briefings
List Briefings
curl --request GET \
  --url https://api.linqalpha.com/v1/briefings \
  --header 'X-API-KEY: <api-key>'
{
  "error": {},
  "payload": [
    {
      "id": "<string>",
      "title": "<string>",
      "topic": "<string>",
      "tickers": [
        "<string>"
      ],
      "language": "<string>",
      "scheduled_time": "<string>",
      "timezone": "<string>",
      "frequency": "daily",
      "scheduled_day_of_week": 123,
      "scheduled_day_of_month": 123,
      "next_delivery_at": "<string>",
      "is_active": true,
      "source_type": "<string>",
      "attach_pdf": true,
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ]
}
Retrieve all briefing schedules for the authenticated user. Each briefing includes its topic, tickers, schedule configuration, and next delivery time. Use this to display an overview of all active and inactive briefings.

Response

Returns a flat array of briefing objects. The tickers field contains resolved ticker symbols and next_delivery_at shows when the next briefing will be generated.

Authorizations

X-API-KEY
string
header
required

Response

200 - application/json

List of briefings

error
object
payload
object[]