|docs
Start Trial
REST APISchedules_v3

Get a rotation

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 rotation by ID including all its events.

Authorization

api_key
Authorization<token>

The API Key with format Token token=<API_KEY>

In: header

Path Parameters

id*string

The ID of the schedule.

rotation_id*string

The ID of the rotation.

Query Parameters

since?string

Start of time range (ISO 8601)

Formatdate-time
until?string

End of time range (ISO 8601)

Formatdate-time

Response Body

application/json

application/json

application/json

application/json

application/json