Sign in
On-Calls

List all of the on-calls

List the on-call entries during a given time range.

An on-call represents a contiguous unit of time for which a User will be on call for a given Escalation Policy and Escalation Rules.

For more information see the API Concepts Document

Scoped OAuth requires: oncalls.read

This API operation has operation specific rate limits. See the Rate Limits page for more information.

get/oncalls

Query parameters

time_zonestring tzinfo

Time zone in which results will be rendered. This will default to the account time zone.

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

totalboolean

By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated.

See our Pagination Docs for more information.

include[]'escalation_policies' | 'users' | 'schedules'

Array of additional details to include.

user_ids[]string[]

Filters the results, showing only on-calls for the specified user IDs.

escalation_policy_ids[]string[]

Filters the results, showing only on-calls for the specified escalation policy IDs.

schedule_ids[]string[]

Filters the results, showing only on-calls for the specified schedule IDs. If null is provided in the array, it includes permanent on-calls due to direct user escalation targets.

sincestring date-time

The start of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future.

untilstring date-time

The end of the time range over which you want to search. If an on-call period overlaps with the range, it will be included in the result. Defaults to current time. On-call shifts are limited to 90 days in the future, and the until time cannot be before the since time.

earliestboolean

This will filter on-calls such that only the earliest on-call for each combination of escalation policy, escalation level, and user is returned. This is useful for determining when the "next" on-calls are for a given set of filters.

Headers

Acceptstring required

The Accept header is used as a versioning header.

Content-Type'application/json' required

Response

A paginated array of on-call objects.

offsetinteger

Echoes offset pagination property.

limitinteger

Echoes limit pagination property.

moreboolean

Indicates if there are additional records to return

totalinteger nullable

The total number of records matching the given query.

oncallsOncall[] required— unresolved $ref

Changes