GET /schedules

List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the API Concepts Document

Scoped OAuth requires: schedules.read

Servers

Request headers

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"

Query parameters

Name Type Required Description
time_zone String No

Time zone in which results will be rendered. This will default to the current user's time zone and then the account's time zone.

query String No

Filters the result, showing only the records whose name matches the query.

limit Integer No

The number of results per page.

include[] String No

Array of additional details to include.

Possible values:

  • "schedule_layers"
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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.