Skip to main content
GET
/
ai-brief-schedules
List AI brief schedules
curl --request GET \
  --url https://core.ravenna.ai/api/ai-brief-schedules \
  --header 'x-ravenna-api-token: <api-key>'
{
  "items": [
    {
      "id": "<string>",
      "dashboardId": "<string>",
      "workspaceId": "<string>",
      "organizationId": "<string>",
      "userId": "<string>",
      "cadence": "daily",
      "slackChannelIds": [
        "<string>"
      ],
      "time": "<string>",
      "day": 123,
      "scheduleId": "<string>",
      "isActive": true,
      "lastRunAt": "<string>",
      "nextScheduledAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "totalCount": 123,
  "nextCursor": "<string>"
}

Authorizations

x-ravenna-api-token
string
header
required

Query Parameters

dashboardId
string
workspaceId
string | null
organizationId
string
isActive
boolean
skip
number | null
Required range: x >= 1
offset
number | null
Required range: x >= 0
cursor
string | null
limit
number | null
default:100
Required range: 1 <= x <= 10000
set
string | null
sortBy
string | null
sortDirection
enum<string> | null
Available options:
asc,
desc
groupBy
string | null
groupDirection
enum<string> | null
Available options:
asc,
desc

Response

Successful response

items
object[]
required
totalCount
number
required
nextCursor
string