v1

latestOpenAPI 3.0.12026-07-233010767.7 KB
On-Calls

List on-calls with flexible filters

get/on-calls

Query parameters

policiesnumber

escalation policy ids to filter on call duties for

policy-levelsstring

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

schedulesnumber

on call schedule ids to filter on call duties for

usersnumber

user ids to filter on call duties for

expandstring

include full entities for: policy, escalationPolicy or user

fromstring

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

untilstring

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

timezonestring

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

start-indexnumber

offset for the search results, defaults to 0

max-resultsnumber

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

Response

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

startstring date-time
endstring date-time
escalationLevelnumber