Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

List custom shifts

<!-- 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 custom shifts for a schedule within a time range.

since and until are required.

get/v3/schedules/{id}/custom_shifts

Path parameters

idstring required

The ID of the schedule.

Query parameters

sincestring date-time required

Start of time range (ISO 8601)

untilstring date-time required

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

limitinteger
offsetinteger

Response

Custom shifts retrieved successfully

limitinteger
offsetinteger
moreboolean

Example response

{
  "custom_shifts": [
    {
      "start_time": "2025-03-15T09:00:00Z",
      "end_time": "2025-03-15T17:00:00Z",
      "assignments": [
        {
          "member": {
            "user_id": "PUSER123"
          }
        }
      ]
    }
  ]
}