Get escalation policy

Returns a single escalation policy by ID.

GET https://incidents.betterstack.com/api/v3/policies/{policy_id}

URL parameters

policy_id
required string

Headers

Authorization
required string
200

Response body

{
  "data": {
    "id": "456",
    "type": "policy",
    "attributes": {
      "name": "Policy A",
      "repeat_count": 5,
      "repeat_delay": 0,
      "fallback_policy_id": null,
      "incident_token": "8nEiLj2gfqjfQRK6vzkFuGC25",
      "policy_group_id": null,
      "team_name": "Test team",
      "steps": [
        {
          "type": "escalation",
          "wait_before": 0,
          "urgency_id": 12345,
          "step_members": [
            {
              "type": "all_slack_integrations"
            },
            {
              "type": "current_on_call"
            }
          ]
        }
      ]
    }
  }
}
404

Response body

{
  "errors": "Resource with provided ID was not found"
}

Response attributes

id
string
type
string
attributes.name
string
attributes.repeat_count
integer
attributes.repeat_delay
integer
attributes.fallback_policy_id
integer or null
attributes.incident_token
string
attributes.policy_group_id
integer or null
attributes.team_name
string
attributes.steps
array
attributes.steps[].type
string
attributes.steps[].wait_before
integer
attributes.steps[].wait_until_time
string
attributes.steps[].wait_until_timezone
string
attributes.steps[].wait_until_days
array
attributes.steps[].urgency_id
integer
attributes.steps[].step_members
array
attributes.steps[].step_members[].type
string
attributes.steps[].step_members[].id
integer
attributes.steps[].step_members[].email
string
attributes.steps[].step_members[].metadata_key
string
attributes.steps[].timezone
string
attributes.steps[].days
array
attributes.steps[].time_from
string
attributes.steps[].time_to
string
attributes.steps[].metadata_key
string
attributes.steps[].metadata_values
array
attributes.steps[].action_type
string
attributes.steps[].policy_id
integer or null
attributes.steps[].policy_metadata_key
string or null
attributes.steps[].instructions_comment
string
attributes.steps[].instructions_reminder_enabled
boolean
attributes.steps[].instructions_reminder_interval_hours
integer

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v3/policies/123 \
  --header "Authorization: Bearer $TOKEN"