Get an on-call schedule by ID.

GET

/on_call_schedule/{schedule_id}

const url = 'https://api.siteqwality.com/on_call_schedule/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.siteqwality.com/on_call_schedule/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

bearer_auth

Parameters

Path Parameters

schedule_id

required

string format: uuid

On-call schedule identifier

Responses

200

On-call schedule

application/json

object

required

string format: uuid

name

required

string

timezone

required

string

created_at

required

string format: date-time

layers

array | null

object

required

string format: uuid

schedule_id

required

string format: uuid

layer_number

required

integer format: int32

rotation_type

required

string

Allowed values: daily weekly custom

rotation_interval_days

integer | null format: int32

handoff_time

required

string

handoff_day

Weekly layers only: weekday of the handoff, 0 = Sunday .. 6 = Saturday, interpreted together with handoff_time in the schedule’s timezone.

integer | null format: int32

participants

required

Array<string>

effective_from

string | null format: date-time

effective_until

string | null format: date-time

created_at

required

string format: date-time

timezone

The layer’s own IANA zone for handoffs and restrictions; absent means the schedule’s.

string | null

restrictions

required

Windows the layer covers; empty means always.

Array<object>

A window a layer covers, repeated every day or every week in the layer’s zone. A window that runs past midnight (or past the end of the week) carries on into the next day.

object

type

required

string

Allowed values: daily weekly

start_day_of_week

Weekly only: the weekday the window opens, 0 = Sunday .. 6 = Saturday.

integer | null format: int32

start_time

required

HH:MM, 24-hour local time.

string

duration_minutes

required

1 to 1440 for daily windows, 1 to 10080 for weekly ones.

integer format: int32

rotation_anchor

One of:

object
null

Where the rotation is counted from: absent on layers created before anchors were stored.

object

date

required

YYYY-MM-DD in the layer’s zone.

string

start_index

required

integer format: int32

version

The current version’s number (1 until the layer is edited). Set by the edit and versions routes.

integer | null format: int32

version_started_at

When the current version took over. Set by the edit and versions routes.

string | null format: date-time

overrides

array | null

object

required

string format: uuid

schedule_id

required

string format: uuid

user_id

required

string format: uuid

start_at

required

string format: date-time

end_at

required

string format: date-time

created_at

required

string format: date-time

Example

{
  "layers": [
    {
      "rotation_type": "daily",
      "restrictions": [
        {
          "type": "daily"
        }
      ]
    }
  ]
}

401

Missing or invalid authentication

404

Schedule not found

500

Internal server error