younifyd
Menu

Get Schedule

Get a schedule

GET/schedules/{id}

Use it in a workflow

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

Request

Path parameters

idstringrequired

The ID of the schedule.

Query parameters

time_zonestring (tzinfo)

Time zone in which results will be rendered. This will default to the schedule's time zone.

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.

overflowboolean

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. For instance, if your schedule is a rotation that changes daily at midnight UTC, and your date range is from `2011-06-01T10:00:00Z` to `2011-06-01T14:00:00Z`: - If you don't pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T10:00:00Z` and end of `2011-06-01T14:00:00Z`. - If you do pass the `overflow=true` parameter, you will get one schedule entry returned with a start of `2011-06-01T00:00:00Z` and end of `2011-06-02T00:00:00Z`.

Default false

include_next_oncall_for_userstring

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

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 an object. Read it in later steps with {{getSchedule.response.data.<field>}}.

scheduleany
json
{
  "schedule": null
}

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