Get schedule
Retrieve the details of a single schedule, including its delivery destinations, recurrence configuration, and current status.
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 of a document.
- 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 the associated dashboard before returning the schedule.
Response
Schedule retrieved successfully
Schedule UUID
Schedule name
Organization UUID
ID of the associated dashboard
The membership ID of the schedule owner. Use the List users endpoint to retrieve membership IDs.
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.
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 dashboard.
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 dashboard.
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
An object specifying the filter conditions to apply to the task. The filter key specified must already exist in the dashboard.
Use the Get dashboard filters and controls endpoint to retrieve filter configuration objects.
Note: Filter keys are case-sensitive and must match exactly.
Format options and other delivery settings

