Skip to main content
List all of the existing escalation policies. Escalation policies define which user should be alerted at which time. For more information see the API Concepts Document.

​
Basic Parameters

ParameterDescription
IncludeArray of additional Models to include in response.
QueryFilters the result, showing only the tags whose labels match the query.
Sort ByUsed to specify the field you wish to sort the results on.
Team IDsAn array of team IDs. Only results related to these teams will be returned. Account must have the teams ability to use this parameter.
User IDsFilters the results, showing only escalation policies on which any of the users is a target.

​
Advanced Parameters

ParameterDescription
LimitThe number of results per page.
OffsetOffset to start pagination search results.
TotalBy 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

{
	"escalation_policies": [
		{
			"id": "PANZZEQ",
			"type": "escalation_policy",
			"summary": "Engineering Escalation Policy",
			"on_call_handoff_notifications": "if_has_services",
			"self": "https://api.pagerduty.com/escalation_policies/PANZZEQ",
			"html_url": "https://subdomain.pagerduty.com/escalation_policies/PANZZEQ",
			"name": "Engineering Escalation Policy",
			"escalation_rules": [
				{
					"id": "PANZZEQ",
					"escalation_delay_in_minutes": 30,
					"targets": [
						{
							"id": "PEYSGVF",
							"summary": "PagerDuty Admin",
							"type": "user_reference",
							"self": "https://api.pagerduty.com/users/PEYSGVF",
							"html_url": "https://subdomain.pagerduty.com/users/PEYSGVF"
						},
						{
							"id": "PI7DH85",
							"summary": "Daily Engineering Rotation",
							"type": "schedule_reference",
							"self": "https://api.pagerduty.com/schedules/PI7DH85",
							"html_url": "https://subdomain.pagerduty.com/schedules/PI7DH85"
						}
					]
				}
			],
			"services": [
				{
					"id": "PIJ90N7",
					"type": "service_reference",
					"summary": "My Mail Service",
					"self": "https://api.pagerduty.com/services/PIJ90N7",
					"html_url": "https://subdomain.pagerduty.com/service-directory/PIJ90N7"
				}
			],
			"num_loops": 0,
			"teams": [
				{
					"id": "PQ9K7I8",
					"type": "team_reference",
					"summary": "Engineering",
					"self": "https://api.pagerduty.com/teams/PQ9K7I8",
					"html_url": "https://subdomain.pagerduty.com/teams/PQ9K7I8"
				}
			]
		}
	],
	"limit": 25,
	"offset": 0,
	"more": false,
	"total": null
}

​
Workflow Library Example

List Escalation Policies with Pagerduty and Send Results Via Email
Workflow LibraryPreview this Workflow on desktop