Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

Get a rotation

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

get/v3/schedules/{id}/rotations/{rotation_id}

Path parameters

idstring required

The ID of the schedule.

rotation_idstring required

The ID of the rotation.

Query parameters

sincestring date-time

Start of time range (ISO 8601)

untilstring date-time

End of time range (ISO 8601)

Response

Rotation retrieved successfully

Example response

{
  "rotation": {
    "id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",
    "events": [
      {
        "id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",
        "name": "Weekly On-Call",
        "start_time": {
          "date_time": "2025-03-03T09:00:00Z",
          "time_zone": "America/New_York"
        },
        "end_time": {
          "date_time": "2025-03-03T09:00:00Z",
          "time_zone": "America/New_York"
        },
        "effective_since": "2025-03-03T00:00:00Z",
        "effective_until": "2025-09-01T00:00:00Z",
        "recurrence": [
          "RRULE:FREQ=WEEKLY"
        ],
        "assignment_strategy": {
          "shifts_per_member": 1,
          "members": [
            {
              "user_id": "PUSER123"
            }
          ]
        }
      }
    ]
  }
}