List Schedules

List the on-call schedules.

A Schedule determines the time periods that users are On-Call.

For more information see the API Concepts Document.

External Documentation

To learn more, visit the PagerDuty documentation.

Basic Parameters

Parameter	Description
Include	Array of additional details to include.
Query	Filters the result, showing only the tags whose labels match the query.

Advanced Parameters

Parameter	Description
Limit	The number of results per page.
Offset	Offset to start pagination search results.
Total	By default the total field in pagination responses is set to null to provide the fastest possible response times. Set total to true for this field to be populated. See our Pagination Docs for more information.

Example Output

{
    "value": {
        "limit": 100,
        "more": false,
        "offset": 0,
        "schedules": [
            {
                "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"
                    }
                ],
                "html_url": "https://subdomain.pagerduty.com/schedules/PI7DH85",
                "id": "PI7DH85",
                "name": "Daily Engineering Rotation",
                "self": "https://api.pagerduty.com/schedules/PI7DH85",
                "summary": "Daily Engineering Rotation",
                "time_zone": "America/New_York",
                "type": "schedule",
                "users": [
                    {
                        "html_url": "https://subdomain.pagerduty.com/users/PEYSGVF",
                        "id": "PEYSGVF",
                        "self": "https://api.pagerduty.com/users/PEYSGVF",
                        "summary": "PagerDuty Admin",
                        "type": "user_reference"
                    }
                ]
            }
        ],
        "total": null
    }
}

Workflow Library Example

List Schedules with Pagerduty and Send Results Via Email

Preview this Workflow on desktop