GET /oncalls

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.

Servers

https://api.pagerduty.com

Request headers

Name Type Required Description

Name	Type	Required	Description
`Accept`	String	Yes	The `Accept` header is used as a versioning header. Default value: "application/vnd.pagerduty+json;version=2"
`Content-Type`	String	Yes	Possible values: `"application/json"` Default value: "application/json"

Accept

String

Yes

The Accept header is used as a versioning header.

Default value: "application/vnd.pagerduty+json;version=2"

Content-Type

String

Yes

Possible values:

"application/json"

Default value: "application/json"

Query parameters

Name	Type	Required	Description
`time_zone`	String	No	Time zone in which results will be rendered. This will default to the account time zone.
`limit`	Integer	No	The number of results per page.
`include`	String	No	Array of additional details to include. Possible values: `"users"` `"schedules"` `"escalation_policies"`
`escalation_policy_ids[]`	Array	No	Filters the results, showing only on-calls for the specified escalation policy IDs.
`earliest`	Boolean	No	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.
`until`	String	No	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.
`since`	String	No	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.
`user_ids[]`	Array	No	Filters the results, showing only on-calls for the specified user IDs.
`offset`	Integer	No	Offset to start pagination search results.
`total`	Boolean	No	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. Default value: false
`schedule_ids[]`	Array	No	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.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.