OMomniapp
Schedules

List schedules

Changed on
get/api/v1/schedules

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/schedules
  • Auth
    HTTP bearer

Query parameters

cursorstring

The page number for offset-based pagination.

pageSizeinteger

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

Example:20
sortDirection'asc' | 'desc'

The direction to sort results (asc or desc).

Example:desc
sortField'scheduleName' | 'dashboardName' | 'documentName' | 'ownerName' | 'lastRun' | 'lastRunStatus'

The field to sort results by. Valid values: scheduleName, documentName, ownerName, lastRun, lastRunStatus. dashboardName is deprecated; use documentName.

Example:scheduleName
contentType'dashboard' | 'single tile' | 'workbook tab'

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

Example:dashboard
embedEntitystring

Filter schedules by embed entity.

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

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

Example:email
identifierstring

Filter schedules by the document's unique identifier, which the document's dashboard and workbook share. Can be found in the dashboard's URL after /dashboards/.

Example:12db1a0a
includeDeletedboolean

Include schedules in the trash. The list then holds live schedules plus those deleted inside the organization's trash window, told apart by deletedAt. A deleted schedule whose document is also in the trash is not listed.

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
qstring

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

Example:Weekly
scheduleType'alert' | 'schedule'

Filter by type: alert, schedule.

Example:schedule
status'success' | 'error' | 'canceled' | 'none'

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

Example:success

Response

Paginated list of schedules

Example response

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

Changes

  • 6c4d29f19093Revision changes
    • info

      added the new optional query request parameter includeDeleted

    • info

      added the required property // to the response with the status

  • bb4f102b5d25Revision changes
    • 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

      response property records/items/dashboardName deprecated

    • info

      added the required property // to the response with the status