URL parameters
The ID of the policy you're interested in.
Headers
Bearer $TOKEN
Returns a single escalation policy by ID.
URL parameters
The ID of the policy you're interested in.
Headers
Bearer $TOKEN
Returns the requested escalation policy.
Response body
Response body
Response attributes
The ID of the escalation policy.
Always policy.
The name of the escalation policy.
How many times the whole policy repeats if nobody acknowledges the incident.
How long to wait before each repetition, in seconds.
The ID of the escalation policy to escalate to once this policy has run all its steps and repeats without being acknowledged. null for no further escalation.
The secret token of the policy's incident report form.
The ID of the escalation policy group the policy is in, null when it isn't in one.
The team the policy belongs to.
The policy's steps, in the order they run.
The type of the step: escalation, time_branching, metadata_branching, instructions, or resolve_remove.
How long the step waits after the previous step, in seconds. Present on steps that wait a fixed time.
The time of day the step runs, in HH:MM format. Present instead of wait_before on steps that wait until a time of day.
The time zone of wait_until_time.
The days on which wait_until_time applies, out of mon, tue, wed, thu, fri, sat, and sun.
The ID of the severity that sets how members are notified. On escalation steps.
Who or what the step notifies. On escalation steps.
What to notify: current_on_call, entire_team, user, policy, incident_metadata, ai_sre, a single integration with slack_integration, microsoft_teams_integration, linear_integration, jira_integration, pagerduty_integration, zapier_webhook, webhook, email_integration, zoom_integration, or google_meet_integration, or every integration of a kind with all_slack_integrations, all_microsoft_teams_integrations, all_linear_integrations, all_jira_integrations, all_zapier_integrations, all_webhook_integrations, all_email_integrations, all_splunk_on_call_integrations, all_incident_io_integrations, all_zoom_integrations, or all_google_meet_integrations.
The ID of the notified resource, such as the user, the escalation policy, the integration, or the AI SRE integration. On current_on_call and entire_team, the ID of the on-call calendar or team, present only when one is chosen instead of the team's default.
The e-mail of the notified user, on user members.
The incident metadata key whose users and escalation policies are notified, on incident_metadata members.
The time zone of the time window. On time_branching steps.
The days on which the time window applies, out of mon, tue, wed, thu, fri, sat, and sun. On time_branching steps.
Start of the time window, in HH:MM format. On time_branching steps.
End of the time window, in HH:MM format. On time_branching steps.
The incident metadata key the step checks. On metadata_branching steps.
The metadata values that match, each with a type and either a value or the referenced item's item_id and name, plus email for a User. Types are listed under metadata values. { "type": "no_value" } matches an incident where the key is missing or blank. On metadata_branching steps.
What the step does when it runs or, on branching steps, when the incident matches: escalate_to_policy, do_not_escalate, resolve_incident, or remove_incident. On branching and resolve_remove steps.
The ID of the escalation policy to run when the incident matches. On branching steps.
The incident metadata key holding the escalation policy to run when the incident matches. If the key is missing or holds no policy, the policy stops. On branching steps.
The instructions posted as a comment into the incident timeline. Incident metadata values replace placeholders like {server_region}. On instructions steps.
Whether a reminder is posted periodically until every checkbox is checked. On instructions steps.
How often the reminder is posted, in hours. On instructions steps.
We use cookies to authenticate users, improve the product user experience, and for personalized ads. Learn more.