On-call

Get a schedule's timeline

Who is on call between from and to (default: now and 14 days later; at most 62 days): each layer's shifts, the overrides, and the result, which is who actually gets paged.

get/on-call-schedules/{schedule}/timeline

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Path parameters

schedulestring uuid required

Schedule ID.

Query parameters

fromstring date-time

Start of the window, ISO 8601. Default now.

tostring date-time

End of the window, ISO 8601, at most 62 days after from. Default 14 days after from.

Response

The timeline of the window.

fromstring date-time required

Start of the window

tostring date-time required

End of the window

timezonestring required

The schedule's time zone

Example response

{
  "timezone": "Europe/Amsterdam",
  "layers": [
    {
      "name": "Weekly primary",
      "shifts": [
        {
          "member": {
            "name": "Jane Doe",
            "email": "jane@example.com"
          }
        }
      ]
    }
  ],
  "overrides": [
    {
      "member": {
        "name": "Jane Doe",
        "email": "jane@example.com"
      }
    }
  ],
  "final": [
    {
      "member": {
        "name": "Jane Doe",
        "email": "jane@example.com"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.