Skip to main content
GET
Get schedule

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

UUID of the schedule. Found in the schedule URL after /schedules/.

To find a schedule's ID:

  1. Navigate to the dashboard of a document.
  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 (org API keys only). When provided, the endpoint verifies the user can view the associated dashboard before returning the schedule.

Response

Schedule retrieved successfully

id
string<uuid>

Schedule UUID

name
string

Schedule name

organizationId
string<uuid>

Organization UUID

entityId
string<uuid>

ID of the associated dashboard

ownerId
string<uuid>

User ID of the schedule owner

owner
object
schedule
string

Schedule's cron expression (minute hour day-of-month month day-of-week year)

timezone
string

IANA timezone identifier (e.g., America/New_York)

fanOut
boolean

When true, each recipient receives a personalized delivery

killJobsOnFailure
boolean

When true, the job stops if any queries fail

filterConfig
object | null

Dashboard filter values applied at delivery time

metadata
object | null

Format options and other delivery settings

conditionType
enum<string> | null

Alert condition type. null for standard schedules.

Available options:
RESULTS_CHANGED,
RESULTS_PRESENT,
RESULTS_MISSING
conditionQueryMapKey
string | null

Query key used to evaluate the alert condition. null for standard schedules.

disabledAt
string<date-time> | null

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

systemDisabledAt
string<date-time> | null

Timestamp when the system automatically disabled the schedule

systemDisabledReason
enum<string> | null

Reason for system disabling

Available options:
missingQuery,
noAccess,
orphanedFilterConfigKeys
createdAt
string<date-time>

ISO 8601 creation timestamp

updatedAt
string<date-time>

ISO 8601 last-updated timestamp

destinations
object[]

Delivery destination configurations