SPspectate
On-call

List on-call schedules

Returns the team's schedules, by name, each with who is on call now and the next handoff.

get/on-call-schedules

Request

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

Query parameters

pageinteger

Page number, from 1.

per_pageinteger

Schedules per page, 1 to 100.

Response

Paginated set of OnCallSchedule

current_pageinteger required
first_page_urlstring nullable required
frominteger nullable required
last_page_urlstring nullable required
last_pageinteger required
next_page_urlstring nullable required
pathstring nullable required

Base path for paginator generated URLs.

per_pageinteger required

Number of items shown per page.

prev_page_urlstring nullable required
tointeger nullable required

Number of the last item in the slice.

totalinteger required

Total number of items being paginated.

Example response

{
  "data": [
    {
      "name": "Primary",
      "timezone": "Europe/Amsterdam",
      "current": {
        "member": {
          "name": "Jane Doe",
          "email": "jane@example.com"
        }
      },
      "next": {
        "member": {
          "name": "Jane Doe",
          "email": "jane@example.com"
        }
      },
      "rotations": [
        {
          "name": "Weekly primary",
          "shift_length": 1,
          "start_date": "2026-11-02",
          "handoff_time": "09:00",
          "restrictions": {
            "start_time": "09:00",
            "end_time": "17:00"
          },
          "participants": [
            {
              "name": "Jane Doe",
              "email": "jane@example.com"
            }
          ]
        }
      ],
      "overrides": [
        {
          "member": {
            "name": "Jane Doe",
            "email": "jane@example.com"
          },
          "note": "Covering for Jane's holiday",
          "created_by": {
            "name": "Jane Doe",
            "email": "jane@example.com"
          }
        }
      ],
      "used_by": [
        {
          "name": "On-call engineers"
        }
      ]
    }
  ]
}

Changes

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