Sign in

v1

latestOpenAPI 3.0.22026-07-144652931.4 MB
Schedules_v3

List schedules

<!-- theme: info -->

Important note: Shift-based schedules use the V3 API and are not compatible with V2 automations. To create automations for Shift-Based Schedules, you need to:

  1. Update your automations to use the V3 API for all new shift-based schedules
  2. Keep the V2 endpoint for your existing schedules

An upgrade tool for existing schedules is coming soon; your legacy schedules will keep working in the meantime. Learn more.

Retrieve a paginated list of schedule references. Returns lightweight objects without embedded rotations or events.

Each result is filtered by the caller's read permission; schedules the caller cannot read are silently excluded.

get/v3/schedules

Query parameters

limitinteger

Maximum number of schedules to return

offsetinteger
querystring

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

totalboolean

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.

team_ids[]string[]

An array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.

Response

Schedules retrieved successfully

limitinteger
offsetinteger
moreboolean

Whether additional results exist beyond this page

Example response

{
  "schedules": [
    {
      "id": "PL5FQHC",
      "summary": "Engineering On-Call",
      "self": "https://api.pagerduty.com/v3/schedules/PL5FQHC",
      "html_url": "https://example.pagerduty.com/schedules/PL5FQHC"
    }
  ],
  "limit": 100
}