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
Response
Schedule retrieved successfully
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.
When the task runs, as an AWS EventBridge cron expression (minute hour day-of-month month day-of-week year).
Runs cannot be more frequent than once an hour unless the organization allows a higher frequency. Delivery times are approximate and happen within 15 minutes of the scheduled time.
"0 9 ? * MON *"
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.
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"
Always null; a schedule in the trash returns 404 from this endpoint. To find a deleted schedule, use the includeDeleted parameter on List schedules.

