Get Schedule

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

External Documentation

To learn more, visit the PagerDuty documentation.

Basic Parameters

Parameter	Description
Schedule ID	The ID of the schedule to get details on.

Advanced Parameters

Parameter	Description
Since	The start of the date range over which you want to search.
Time Zone	Time zone in which dates in the result will be rendered.
Until	The end of the date range over which you want to search.

Example Output

{
    "summary": "Response Example",
    "value": {
        "schedule": {
            "description": "Rotation schedule for engineering",
            "escalation_policies": [
                {
                    "html_url": "https://subdomain.pagerduty.com/escalation_policies/PT20YPA",
                    "id": "PT20YPA",
                    "self": "https://api.pagerduty.com/escalation_policies/PT20YPA",
                    "summary": "Another Escalation Policy",
                    "type": "escalation_policy_reference"
                }
            ],
            "final_schedule": {
                "name": "Final Schedule",
                "rendered_coverage_percentage": 37.5,
                "rendered_schedule_entries": [
                    {
                        "end": "2015-11-10T17:00:00-05:00",
                        "start": "2015-11-10T08:00:00-05:00",
                        "user": {
                            "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
                            "id": "PXPGF42",
                            "self": "https://api.pagerduty.com/users/PXPGF42",
                            "summary": "Regina Phalange",
                            "type": "user_reference"
                        }
                    }
                ]
            },
            "html_url": "https://subdomain.pagerduty.com/schedules/PI7DH85",
            "id": "PI7DH85",
            "name": "Daily Engineering Rotation",
            "overrides_subschedule": {
                "name": "Overrides",
                "rendered_coverage_percentage": 0,
                "rendered_schedule_entries": []
            },
            "schedule_layers": [
                {
                    "id": "PG68P1M",
                    "name": "Layer 1",
                    "rendered_coverage_percentage": 37.5,
                    "rendered_schedule_entries": [
                        {
                            "end": "2015-11-09T17:00:00-05:00",
                            "start": "2015-11-09T08:00:00-05:00",
                            "user": {
                                "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
                                "id": "PXPGF42",
                                "self": "https://api.pagerduty.com/users/PXPGF42",
                                "summary": "Regina Phalange",
                                "type": "user_reference"
                            }
                        }
                    ],
                    "restrictions": [
                        {
                            "duration_seconds": 32400,
                            "start_time_of_day": "08:00:00",
                            "type": "daily_restriction"
                        }
                    ],
                    "rotation_turn_length_seconds": 86400,
                    "rotation_virtual_start": "2015-11-06T20:00:00-05:00",
                    "start": "2015-11-06T21:00:00-05:00",
                    "users": [
                        {
                            "user": {
                                "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
                                "id": "PXPGF42",
                                "self": "https://api.pagerduty.com/users/PXPGF42",
                                "summary": "Regina Phalange",
                                "type": "user_reference"
                            }
                        }
                    ]
                }
            ],
            "self": "https://api.pagerduty.com/schedules/PI7DH85",
            "summary": "Daily Engineering Rotation",
            "teams": [
                {
                    "html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8",
                    "id": "PQ9K7I8",
                    "self": "https://api.pagerduty.com/teams/PQ9K7I8",
                    "summary": "Engineering",
                    "type": "team_reference"
                }
            ],
            "time_zone": "America/New_York",
            "type": "schedule",
            "users": [
                {
                    "html_url": "https://subdomain.pagerduty.com/users/PXPGF42",
                    "id": "PXPGF42",
                    "self": "https://api.pagerduty.com/users/PXPGF42",
                    "summary": "Regina Phalange",
                    "type": "user_reference"
                }
            ]
        }
    }
}

Workflow Library Example

Get Schedule with Pagerduty and Send Results Via Email

Preview this Workflow on desktop