Get schedule
Retrieve the details of a single schedule, including its delivery destinations, recurrence configuration, and current status. A schedule can deliver a dashboard or a workbook.
API key behavior
How this endpoint behaves depends on the type of API key being used:Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the schedule. To find a schedule's ID:
- Navigate to the dashboard or workbook.
- Click File > Deliveries & Alerts.
- 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
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
Schedule UUID
Schedule name
Organization UUID
What the schedule delivers: the dashboard, or a tab of the workbook.
dashboard, workbook Identifier of the document the schedule delivers. Shared by the document's dashboard and workbook.
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.
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.
AWS EventBridge cron expression (minute hour day-of-month month day-of-week year)
"0 9 ? * MON *"
IANA timezone identifier
"America/New_York"
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.
If true, stops the entire job if any queries included in the task fail.
false
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.
"Jmn2r3KV"
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.
"Jmn2r3KV"
Timestamp when the schedule was manually paused. null if active.
Timestamp when the system disabled the schedule
Reason for the system disabling the schdule.
contentRemoved, credentialMissing, destinationDisabled, missingQuery, noAccess, orphanedFilterConfigKeys, ownerRevoked ISO 8601 creation timestamp
ISO 8601 last-updated timestamp
Delivery destination configurations
Dashboard deliveries only. The effective dashboard filter configuration the schedule runs with. Omitted entirely (not null) for workbook deliveries, which have no filters.
Format options and other delivery settings

