younifyd
Menu

List Schedules

List schedules

GET/schedules

Use it in a workflow

  1. Add a step and choose the PagerDuty connector.
  2. Pick the List Schedules action (under Schedules).
  3. Fill in the fields below, then reference the result from later steps as {{listSchedules.response.data}}.

Request

Query parameters

limitinteger

The number of results per page.

offsetinteger

Offset to start pagination search results.

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](https://developer.pagerduty.com/docs/rest-api-v2/pagination/) for more information.

Default false

querystring

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

include[]string

Array of additional details to include.

One ofschedule_layersoverrides_subschedulefinal_schedule

time_zonestring (tzinfo)

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.

include_next_oncall_for_userstring

Specify an `user_id`, and the schedule list API will return information about this user's next on-call.

sincestring (date-time)

The start of the date range over which you want to show schedule entries. Defaults to 2 weeks before until if an until is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response.

untilstring (date-time)

The end of the date range over which you want to show schedule entries. Defaults to 2 weeks after since if a since is given. Optional parameter. When provided with include[] for schedule types, populates the rendered_schedule_entries fields in the response.

team_ids[]array<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.

Headers

Acceptstringrequired

The `Accept` header is used as a versioning header.

Default "application/vnd.pagerduty+json;version=2"

Content-Typestringrequired

One ofapplication/jsonDefault "application/json"

Response

Returns 200 with a any. Read it in later steps with {{listSchedules.response.data.<field>}}.

Need more? See the PagerDuty guide for connection setup and behaviour shared by every action.

List Schedules — PagerDuty — Documentation