{ "opencollection": "1.0.0", "info": { "name": "PagerDuty Abilities On-Calls API", "version": "2.0.0" }, "request": { "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "items": [ { "info": { "name": "On-Calls", "type": "folder" }, "items": [ { "info": { "name": "PagerDuty List all of the on-calls", "type": "http" }, "http": { "method": "GET", "url": "https://api.pagerduty.com/oncalls", "headers": [ { "name": "Accept", "value": "" }, { "name": "Content-Type", "value": "" } ], "params": [ { "name": "time_zone", "value": "", "type": "query", "description": "Time zone in which results will be rendered. This will default to the account time zone." }, { "name": "limit", "value": "", "type": "query", "description": "The number of results per page." }, { "name": "offset", "value": "", "type": "query", "description": "Offset to start pagination search results." }, { "name": "total", "value": "", "type": "query", "description": "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.\n\nSee our [Pagination Docs](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.\n" }, { "name": "include[]", "value": "", "type": "query", "description": "Array of additional details to include." }, { "name": "user_ids[]", "value": "", "type": "query", "description": "Filters the results, showing only on-calls for the specified user IDs." }, { "name": "escalation_policy_ids[]", "value": "", "type": "query", "description": "Filters the results, showing only on-calls for the specified escalation policy IDs." }, { "name": "schedule_ids[]", "value": "", "type": "query", "description": "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." }, { "name": "since", "value": "", "type": "query", "description": "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." }, { "name": "until", "value": "", "type": "query", "description": "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." }, { "name": "earliest", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the on-call entries during a given time range.\n\nAn on-call represents a contiguous unit of time for which a User will be on call for a given Escalation Policy and Escalation Rules.\n\nFor more information see the [API Concepts Document](../../api-reference/ZG9jOjI3NDc5Nzc-api-concepts#on-calls)\n\nScoped OAuth requires: `oncalls.read`\n\nThis API operation has operation specific rate limits. See the [Rate Limits](https://developer.pagerduty.com/docs/72d3b724589e3-rest-api-rate-limits) page for mo" } ] } ], "bundled": true }