Sign in
Schedules_v3

Get a schedule

<!-- theme: info -->

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

  1. Update your automations to use the V3 API for all new shift-based schedules
  2. Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

Retrieve a schedule by ID including rotations and events. Optionally include the computed final schedule for a time range.

Use include[]=final_schedule to get computed on-call assignments. Use since and until to specify the time range.

get/v3/schedules/{id}

Path parameters

idstring required

The ID of the schedule.

Query parameters

sincestring date-time

Start of time range (ISO 8601)

untilstring date-time

End of time range (ISO 8601)

time_zonestring

IANA timezone identifier for rendering shift times. Defaults to the schedule's configured time zone.

overflowboolean

Include shifts that extend beyond the requested time range boundaries

include[]string[]

Additional data to include in the schedule response:

  • final_schedule: computed on-call assignments for the time range

Response

Schedule retrieved successfully

ScheduleResponse required— unresolved $ref

Changes