Skip to main content

​
Overview

Retrieves complete details for a specific on-call schedule by its ID, including schedule layers, rotation information, and associated users and teams.
This is a read-only tool that does not modify any data in your PagerDuty account.

​
Parameters

​
schedule_id
string
required
The ID of the schedule to retrieve. This is the unique identifier for the schedule in PagerDuty.

​
Response

Returns a detailed schedule object with the following fields:
​
id
string
The unique identifier for the schedule
​
name
string
The name of the schedule
​
summary
string
A short description of the schedule
​
description
string
The full description of the schedule
​
time_zone
string
The time zone of the schedule (IANA format, e.g., “America/New_York”)
​
html_url
string
The URL to view the schedule in PagerDuty
​
created_at
datetime
When the schedule was created
​
updated_at
datetime
When the schedule was last updated
​
users
array
List of users associated with this schedule. Each user includes:
  • id - User ID
  • summary - User name
  • html_url - Link to user profile
​
teams
array
List of teams associated with this schedule. Each team includes:
  • id - Team ID
  • summary - Team name
  • html_url - Link to team page
​
schedule_layers
array
The schedule layers that define the rotation. Each layer includes:
  • id - Layer ID
  • name - Layer name
  • start - When the layer starts
  • end - When the layer ends (null if ongoing)
  • rotation_virtual_start - The effective start time
  • rotation_turn_length_seconds - Duration of each shift
  • users - Ordered list of users in the rotation
  • restrictions - Time restrictions for the layer

​
Example Usage

​
Get schedule by ID

Show me details for schedule P4B2Z3G

​
View schedule configuration

What is the configuration for the "Production Ops" schedule?

​
Check schedule rotation

How is the rotation set up for schedule P4B2Z3G?

​
Understanding Schedule Layers

Schedules in PagerDuty are built using layers, which define:
  • Rotation order - The sequence of users who take on-call shifts
  • Shift duration - How long each user is on-call (e.g., 1 week, 24 hours)
  • Time restrictions - Limits on when the layer is active (e.g., business hours only)
  • Start and end dates - When the layer begins and ends
Multiple layers can be combined to create complex schedules with different coverage patterns.

​
Common Use Cases

  • Review configuration - Examine how a schedule is set up
  • Verify rotation - Check the order and timing of on-call shifts
  • Troubleshooting - Debug schedule issues by reviewing layer details
  • Documentation - Generate reports on schedule configurations
  • Planning changes - Review current settings before making updates

list_schedules

List all schedules

list_oncalls

See who is currently on-call

update_schedule

Modify the schedule (write mode)

create_override

Create a schedule override (write mode)

Build docs developers (and LLMs) love

Get started for freeTalk to us