Sign in

v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Schedules

List schedules

Retrieves scheduled tasks. This endpoint supports filtering, sorting, and cursor-based pagination.

To retrieve the recipients for a schedule, use the List schedule recipients endpoint.

get/v1/schedules

Query parameters

qstring

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

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

Filter schedules by delivery status.

destination'email' | 'slack' | 'webhook' | 'sftp' | 's3'

Filter schedules by destination type.

scheduleType'alert' | 'schedule'

Filter by schedule type.

contentType'dashboard' | 'single tile'

Filter schedules by content type.

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

The field to sort results by.

sortDirection'asc' | 'desc'

The direction to sort results.

cursorinteger

The page number for offset-based pagination.

pageSizeinteger

The number of results to include on each page.

ownerIdstring uuid

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

API results vary by API key type:

  • Organization API keys - When specified, only schedules for the specified owner are returned. Otherwise, all schedules in the organization are returned.
  • Personal access token - When specified, only the token owner's membership ID is allowed. If another user's membership ID is provided, the API will return a 403 Forbidden error.
embedEntitystring

Filter schedules by embed entity:

  • If used as the only filter, list all schedules in the embed entity
  • If used with ownerId, list only schedules for the specified user if they are associated with the embedEntity. The response will be empty if the specified ownerId doesn't have the entity.
  • Can be combined with other filters for more specific results
identifierstring

Filter schedules by dashboard ID. This can be retrieved by:

  • Opening the document settings - Navigate to File > Document settings in the dashboard and then click Settings. The Identifier field contains the dashboard ID.
  • Using the dashboard's URL - The string after /dashboards is the dashboard's ID; for example: https://myorg.omniapp.co/dashboards/12db1a0a

Response

Paginated schedule list