GET /schedules/{id}/overrides

List overrides for a given time range.

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

Path parameters

Name Type Required Description
id String Yes

The ID of the resource.

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
overflow Boolean No

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless the parameter overflow=true is passed. This parameter defaults to false.

until String Yes

The end of the date range over which you want to search.

since String Yes

The start of the date range over which you want to search.

editable Boolean No

When this parameter is present, only editable overrides will be returned. The result will only include the id of the override if this parameter is present. Only future overrides are editable.

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.