On Calls

List on-calls with flexible filters

get

Authorizations

Query parameters

policiesnumberOptional

escalation policy ids to filter on call duties for

policy-levelsstringOptional

can be provided instead of 'policies', must be a serialised and urlencoded JSON object e.g. ?policy-levels="{ "id": 12, "level": 1 }" where id is the policy id and level is the escalation level that should be included

schedulesnumberOptional

on call schedule ids to filter on call duties for

usersnumberOptional

user ids to filter on call duties for

expandstringOptional

include full entities for: policy, escalationPolicy or user

fromstringOptional

date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, start of the time range, may not exceed 3 months in total span, defaults to current time

untilstringOptional

date-time ISO-UTC e.g. 2021-05-25T21:24:56.771Z, end of the time range, must be after 'from', defaults to current time

timezonestringOptional

Time zone in which the results will be rendered, defaults to UTC

start-indexnumberOptional

offset for the search results, defaults to 0

max-resultsnumberOptional

limit for the search results, defaults to 50, may not exceed 250

Responses

200

returns a list of on-call objects for the searched window

application/json

get

HTTPcURLJavaScriptPython

GET /api/on-calls HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

200

returns a list of on-call objects for the searched window

[
  {
    "user": {
      "id": 1,
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "timezone": "Europe/Berlin",
      "position": "text",
      "department": "text",
      "avatarUrl": "text",
      "language": "de",
      "region": "DE",
      "role": "STAKEHOLDER",
      "shiftColor": "text",
      "mutedUntil": "2025-07-08T08:14:43.194Z",
      "createdAt": "2025-07-08T08:14:43.194Z",
      "updatedAt": "2025-07-08T08:14:43.194Z"
    },
    "escalationPolicy": {
      "id": 1,
      "name": "text",
      "escalationRules": [
        {
          "escalationTimeout": 1,
          "user": {
            "id": 1
          },
          "schedule": {
            "id": 1
          },
          "users": [
            {
              "id": 1,
              "firstName": "text",
              "lastName": "text"
            }
          ],
          "schedules": [
            {
              "id": 1,
              "name": "text",
              "type": "STATIC"
            }
          ]
        }
      ],
      "teams": [
        {
          "id": 1,
          "name": "text"
        }
      ],
      "repeating": false,
      "frequency": 1,
      "delayMin": 0,
      "routingKey": "text"
    },
    "schedule": {
      "id": 1,
      "name": "text",
      "type": "STATIC"
    },
    "start": "2025-07-08T08:14:43.194Z",
    "end": "2025-07-08T08:14:43.194Z",
    "escalationLevel": 1
  }
]