v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Schedules

List schedules

get/api/v1/schedules

Query parameters

cursorstring

The page number for offset-based pagination.

pageSizeinteger

Number of results per page (1-100, integer)

Example:20

Number of results per page (1-100, integer)

sortDirection'asc' | 'desc'

The direction to sort results (asc or desc).

Example:desc

The direction to sort results (asc or desc).

sortField'scheduleName' | 'dashboardName' | 'ownerName' | 'lastRun' | 'lastRunStatus'

The field to sort results by. Valid values: scheduleName, dashboardName, ownerName, lastRun, lastRunStatus.

Example:scheduleName

The field to sort results by. Valid values: scheduleName, dashboardName, ownerName, lastRun, lastRunStatus.

contentType'dashboard' | 'single tile'

Filter schedules by content type: dashboard, single tile.

Example:dashboard

Filter schedules by content type: dashboard, single tile.

embedEntitystring

Filter schedules by embed entity.

Filter schedules by destination type: email, slack, webhook, sftp, s3.

Example:email

Filter schedules by destination type: email, slack, webhook, sftp, s3.

identifierstring

Filter schedules by the document's unique identifier. Can be found in the dashboard's URL after /dashboards/.

Example:12db1a0a

Filter schedules by the document's unique identifier. Can be found in the dashboard's URL after /dashboards/.

ownerIdstring uuid

Filter schedules by the owner's user ID. Use the List users endpoint to retrieve user IDs.

Example:987fcdeb-51a2-43d7-9b56-254415f67890

Filter schedules by the owner's user ID. Use the List users endpoint to retrieve user IDs.

qstring

Search term for filtering schedules by name, dashboard name, or owner name (case-insensitive).

Example:Weekly

Search term for filtering schedules by name, dashboard name, or owner name (case-insensitive).

scheduleType'alert' | 'schedule'

Filter by type: alert, schedule.

Example:schedule

Filter by type: alert, schedule.

status'success' | 'error' | 'canceled' | 'none'

Filter schedules by delivery status: success, error, canceled, none.

Example:success

Filter schedules by delivery status: success, error, canceled, none.

Response

Paginated list of schedules

Example response

{
  "records": [
    {
      "content": "dashboard",
      "dashboardName": "Weekly Sales Report",
      "destinationType": "email",
      "format": "pdf",
      "identifier": "12db1a0a",
      "name": "Weekly Sales Report",
      "ownerName": "John Doe",
      "recipientCount": 5,
      "schedule": "0 9 ? * MON *",
      "timezone": "America/New_York"
    }
  ]
}