Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

Get an override

<!-- 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 single override by ID.

get/v3/schedules/{id}/overrides/{override_id}

Path parameters

idstring required

The ID of the schedule.

override_idstring required

The ID of the override.

Response

Override retrieved successfully

Example response

{
  "override": {
    "rotation_id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",
    "start_time": "2025-03-15T09:00:00Z",
    "end_time": "2025-03-15T17:00:00Z",
    "overridden_member": {
      "user_id": "PUSER123"
    },
    "overriding_member": {
      "user_id": "PUSER123"
    }
  }
}