Retrieves the current on-call information for your PagerDuty account. This endpoint provides a comprehensive view of who is currently on-call across various schedules and escalation policies. It's particularly useful for getting an overview of your organization's current on-call…
limitintegerThe number of results per page.
sincestringThe 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.
totalbooleanBy 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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more informatio…
untilstringThe 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.
offsetintegerOffset to start pagination search results.
includestringOptions for including additional details in the response. - escalation_policies: Include full escalation policy details - users: Include full user details with contact methods - schedules: Include full schedule details
earliestbooleanThis 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.
user_idsarrayFilters the results, showing only on-calls for the specified user IDs.
time_zonestringTime zone in which results will be rendered. This will default to the account time zone.
schedule_idsarrayFilters 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.
escalation_policy_idsarrayFilters the results, showing only on-calls for the specified escalation policy IDs.
dataRequiredData from the action execution
errorstringError if any occurred during the execution of the action
successfulRequiredbooleanWhether or not the action execution was successful or not
API key connection. Risk level 2 of 5.
Free Action