List existing on-call schedules.

GET /schedules

See: http://developer.pagerduty.com/documentation/rest/schedules/list

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

Show detailed information about a schedule, including entries for each layer and sub-schedule.

GET /schedules/:id

See: http://developer.pagerduty.com/documentation/rest/schedules/show

The start of the date range over which you want to return on-call schedule entries and on-call schedule layers.

The end of the date range over which you want to return schedule entries and on-call schedule layers.

Time zone in which dates in the result will be rendered.

Default: account time zone.

List all the users on-call in a given schedule for a given time range.

GET /schedules/:id/users

See: http://developer.pagerduty.com/documentation/rest/schedules/users

The start of the date range over which you want to return on-call users.

The end time of the date range over which you want to return on-call users.

List schedule entries that are active for a given time range for a specified on-call schedule.

GET /schedules/:id/entries

See: http://developer.pagerduty.com/documentation/rest/schedules/entries

The start of the date range over which you want to return on-call schedule entries. The maximum range queryable at once is three months.

The end of the date range over which you want to return schedule entries.

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

Default: false.

Example: 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.

Time zone in which dates in the result will be rendered.

Default: account time zone.

To filter the returned on-call schedule entries by a specific user, you can optionally add the user_id parameter to the query.

Create a new on-call schedule.

POST /schedules

See: http://developer.pagerduty.com/documentation/rest/schedules/create

The name of the schedule.

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless csOverflow is set to True.

Default: False.

The time zone of the schedule.

Default: UTC.

A list of schedule layers.

Update an existing on-call schedule.

Note: You cannot delete schedule layers. You must include all layers in your update request. To delete a layer, set the end parameter to schedule its termination.

PUT /schedules/:id

See: http://developer.pagerduty.com/documentation/rest/schedules/update

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless usOverflow is set to True.

Default: False.

The time zone of the schedule.

A list of schedule layers.

Preview what a schedule would look like without saving it. This work the same as the update or create actions, except that the result is not persisted. Preview optionally takes two additional arguments, since and until, deliminating the span of the preview.

POST /schedules/preview

See: http://developer.pagerduty.com/documentation/rest/schedules/preview

The start of the date range over which you want to return on-call schedule entries and on-call schedule layers.

The end of the date range over which you want to return schedule entries and on-call schedule layers.

Any on-call schedule entries that pass the date range bounds will be truncated at the bounds, unless psOverflow is set to True.

Default: False.

The name of the schedule.

The time zone of the schedule.

Default: UTC.

A list of schedule layers.

Delete an on-call schedule.

DELETE /schedules/:id

See: http://developer.pagerduty.com/documentation/rest/schedules/delete

A schedule is composed of multiple schedule layers.

A layer is composed of a group of people who will rotate through the same shift. In a basic weekly schedule, you create a single layer where each member is on-call for one week, with a set day and time for transferring on-call duty.

When a schedule has multiple layers, the layer can be ordered using the priority field. The layer with the highest priority has precedence over the layers with lower priority. You can use restrictions to control how layers overlap.

The override layer is a special layer where all the override entries are stored.

The final layer is a special layer that contains the result of all the previous layers put together. This layer cannot be edited.

This is a list of entries to be rendered for the current time range.

This specifies the type of restrictions present on this layer.

A list of time restrictions for this layer.

The priority of the layer. Layers with higher priority will override layers with a lower priority.

The effective start date of the layer

The effective end date of the layer. If Nothing, the layer has no end date.

The percentage of the time range covered by this layer.

The duration of each on-call shift in seconds.

The effective start time of the layer. This can be before the start time of the schedule.

An ordered list of users in this layer. The member_order field controls the order in which the users apear in the rotation.

A list of schedule layers. See the schedule layers parameters for details.

The schedule layer object where all the overrides are stored.

The final schedule layer object.