Schedules_v3
List rotations
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:
- Update your automations to use the V3 API for all new shift-based schedules
- 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 all rotations for a schedule.
get/v3/schedules/{id}/rotations
Request
- Base URLhttps://api.pagerduty.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
The ID of the schedule.
Query parameters
limitinteger
offsetinteger
Response
Rotations retrieved successfully
Example response
{
"rotations": [
{
"id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",
"events": [
{
"id": "ABCDEFGHIJKLMNOPQRSTUVWXY2",
"name": "Weekly On-Call",
"start_time": {
"date_time": "2025-03-03T09:00:00Z",
"time_zone": "America/New_York"
},
"end_time": {
"date_time": "2025-03-03T09:00:00Z",
"time_zone": "America/New_York"
},
"effective_since": "2025-03-03T00:00:00Z",
"effective_until": "2025-09-01T00:00:00Z",
"recurrence": [
"RRULE:FREQ=WEEKLY"
],
"assignment_strategy": {
"shifts_per_member": 1,
"members": [
{
"user_id": "PUSER123"
}
]
}
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.