AI13

AI Credit Controls6

AI Credit Usage2

AI Eval12

AI Model Suggestions9

AI Routines6

API Tokens4

App downloads3

Apps8

Branches3

Color Palettes5

Connection environments3

Connections5

Content2

Content migration2

Content validator2

Dashboard downloads3

Dashboard filters2

dbt9

Document favorites3

Document labels3

Document permissions6

Documents16

Documents v27

Embed1

Folder favorites2

Folder labels1

Folder permissions5

Folders5

IP Allowlist2

Jobs1

Labels5

Model branches1

Model Git configuration7

Models17

Queries3

Schedule recipients6

Schedules10

Schema refresh schedules5

Skills5

Topics4

Uploads4

User attributes9

User group model roles2

User groups6

User model roles2

Users10

Who Am I1

Schedules

List schedules

Changed on Nov 3, 2026

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

Request

Base URL
https://blobsrus.omniapp.co/api
URL
https://blobsrus.omniapp.co/api/v1/schedules
Auth
HTTP bearer

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' | 'workbook tab'

Filter schedules by content type: dashboard, single tile, workbook tab.

The field to sort results by. dashboardName is deprecated; use documentName instead.

sortDirection'asc' | 'desc'

Direction for sorting results:

asc - Ascending order (A-Z, 0-9)
desc - Descending order (Z-A, 9-0)

cursorstring

Example:eyJpZCI6IjEyMzQ1In0

Cursor for pagination from previous response nextCursor.

pageSizeinteger

Example:20

Number of results per 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 the document's unique identifier. This identifier is shared by a document's dashboard and workbook. 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 document's ID.
Using the dashboard's URL - The string after /dashboards is the document's ID; for example: https://myorg.omniapp.co/dashboards/12db1a0a

includeDeletedboolean

When true, the response also includes schedules in the trash. A trashed schedule is removed from the list once the organization's trash window has passed or if its document is also in the trash.

Response

Paginated schedule list

Example response

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

Changes

Nov 3, 202643290040f88f Revision changes
- breaking
  for the query request parameter cursor, default value 1 was removed
- breaking
  for the query request parameter sortDirection, default value desc was removed
- breaking
  the // response's property type changed from string to object for status
- breaking
  the // response's property type changed from string to object for status
- breaking
  the // response's property type changed from integer to number for status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  removed the optional property from the response with the status
- warning
  added the new COMPLETE enum value to the // response property for the response status
- warning
  added the new CONDITION_UNMET enum value to the // response property for the response status
- warning
  added the new ERROR enum value to the // response property for the response status
- warning
  added the new ERROR_DELIVERED enum value to the // response property for the response status
- warning
  added the new KILLED enum value to the // response property for the response status
- warning
  added the new channel enum value to the // response property for the response status
- warning
  added the new contentRemoved enum value to the // response property for the response status
- warning
  added the new credentialMissing enum value to the // response property for the response status
- warning
  added the new csv enum value to the // response property for the response status
- warning
  added the new dashboard enum value to the // response property for the response status
- warning
  added the new destinationDisabled enum value to the // response property for the response status
- warning
  added the new email enum value to the // response property for the response status
- warning
  added the new google_sheets enum value to the // response property for the response status
- warning
  added the new json enum value to the // response property for the response status
- warning
  added the new link_only enum value to the // response property for the response status
- warning
  added the new missingQuery enum value to the // response property for the response status
- warning
  added the new noAccess enum value to the // response property for the response status
- warning
  added the new orphanedFilterConfigKeys enum value to the // response property for the response status
- warning
  added the new ownerRevoked enum value to the // response property for the response status
- warning
  added the new pdf enum value to the // response property for the response status
- warning
  added the new png enum value to the // response property for the response status
- warning
  added the new s3 enum value to the // response property for the response status
- warning
  added the new sftp enum value to the // response property for the response status
- warning
  added the new slack enum value to the // response property for the response status
- warning
  added the new tile enum value to the // response property for the response status
- warning
  added the new users enum value to the // response property for the response status
- warning
  added the new webhook enum value to the // response property for the response status
- warning
  added the new workbook tab enum value to the // response property for the response status
- warning
  added the new xlsx enum value to the // response property for the response status
- info
  api operation id listSchedules removed and replaced with schedulesList
- info
  added the new optional query request parameter includeDeleted
- info
  added the new enum value documentName to the query request parameter sortField
- info
  added the new enum value workbook tab to the query request parameter contentType
- info
  for the query request parameter cursor, the type was generalized from integer to string
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  the response property // became required for the status
- info
  response property records/items/dashboardName deprecated
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property /// to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history