Skip to main content
GET
Get schedule

API key behavior

How this endpoint behaves depends on the type of API key being used:

Authorizations

Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

scheduleId
string<uuid>
required

The ID of the schedule. To find a schedule's ID:

  1. Navigate to the dashboard or workbook.
  2. Click File > Deliveries & Alerts.
  3. Next to a schedule, click Edit.

The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:

Query Parameters

userId
string<uuid>

Membership ID of the user whose permissions should be checked (Organization API keys only). When provided, the endpoint verifies the user can view and schedule the associated dashboard or workbook before returning the schedule.

Response

Schedule retrieved successfully

id
string<uuid>
required

Schedule UUID

name
string
required

Schedule name

organizationId
string<uuid>
required

Organization UUID

entity
enum<string>
required

What the schedule delivers: the dashboard, or a tab of the workbook.

Available options:
dashboard,
workbook
documentIdentifier
string
required

Identifier of the document the schedule delivers. Shared by the document's dashboard and workbook.

entityId
string<uuid>
required
deprecated

Deprecated. Use documentIdentifier instead. Internal ID of the dashboard, or of the document for a workbook delivery. For dashboards, this value changes when the dashboard is published.

owner
object
required
ownerId
string<uuid>
required

The user ID of the schedule owner, as returned by the List users endpoint.

In the rare case the owner has no membership in the organization at all (for example, an embed user removed through a hard delete), this falls back to the owner's raw user ID instead.

schedule
string
required

AWS EventBridge cron expression (minute hour day-of-month month day-of-week year)

Example:

"0 9 ? * MON *"

timezone
string
required

IANA timezone identifier

Example:

"America/New_York"

fanOut
boolean
required

When true, each recipient receives a personalized delivery. The value returned reflects the organization's delivery personalization setting: if set to Never, this will always be false; if set to Always, this reflects the forced-personalization state. See Personalizing email deliveries for more information.

Note: Personalized deliveries aren't supported for connections that use OAuth sign-in. In this case, the delivery will fail.

killJobsOnFailure
boolean
default:false
required

If true, stops the entire job if any queries included in the task fail.

Example:

false

conditionQueryMapKey
string | null
required

Required if conditionType is provided. The ID of the query to monitor for triggering an alert. Must reference a valid query in the document. For a workbook delivery, this must be a tab of the published workbook.

In responses, null for standard schedules.

Example:

"Jmn2r3KV"

conditionType
string | null
required

Required if conditionType is provided. The ID of the query to monitor for triggering an alert. Must reference a valid query in the document. For a workbook delivery, this must be a tab of the published workbook.

In responses, null for standard schedules.

Example:

"Jmn2r3KV"

disabledAt
string<date-time> | null
required

Timestamp when the schedule was manually paused. null if active.

systemDisabledAt
string<date-time> | null
required

Timestamp when the system disabled the schedule

systemDisabledReason
enum<string> | null
required

Reason for the system disabling the schdule.

Available options:
contentRemoved,
credentialMissing,
destinationDisabled,
missingQuery,
noAccess,
orphanedFilterConfigKeys,
ownerRevoked
createdAt
string<date-time>
required

ISO 8601 creation timestamp

updatedAt
string<date-time>
required

ISO 8601 last-updated timestamp

destinations
object[]
required

Delivery destination configurations

filterConfig
object | null

Dashboard deliveries only. The effective dashboard filter configuration the schedule runs with. Omitted entirely (not null) for workbook deliveries, which have no filters.

Example:
metadata
object | null

Format options and other delivery settings