Explore documentation
  1. Welcome to Incidents 👋
  2. Frequently Asked Questions
  3. On-call scheduling and alerting
    1. Get started
    2. Slack and other integrations ↗
    3. Tag on-call in Slack
    4. Mobile apps ↗
    5. Connecting external calendars
    6. Advanced guide
  4. Incident management
    1. Get started
    2. Post mortems
    3. Metadata & Catalog
    4. Screening alerts
    5. Reporting ↗
  5. Monitoring
    1. Get started
    2. Working with monitors
    3. Customizing monitors
    4. Monitor types
  6. Status pages
    1. Get started
    2. Advanced guide
  7. Incidents API
    1. Getting an API token
    2. Pagination
    3. Monitors
    4. Heartbeats
    5. On-call & incidents
      1. On-call schedule
      2. On-call schedule events
      3. On-call schedule rotations
      4. Escalation policies
      5. Escalation policy groups
        1. List escalation policy groups GET
        2. Get escalation policy group GET
        3. List policies in group GET
        4. Create escalation policy group POST
        5. Update escalation policy group PATCH
        6. Remove escalation policy group DELETE
      6. Severities
      7. Severity groups
      8. Incidents
      9. Comments
    6. Status pages
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

List escalation policy groups

Returns a list of all your escalation policy groups.

GET https://incidents.betterstack.com/api/v2/policy-groups

Query parameters

team_name
string

Filter policy groups belonging to a specified team when using global API token.

page
integer

The page number to return, starting with 1.

per_page
integer

Number of results per page. Defaults to 50, maximum 250.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a list of existing escalation policy groups, ordered by sort_index.

Response body

{
  "data": [
    {
      "id": "95251342",
      "type": "policy_group",
      "attributes": {
        "name": "Example",
        "sort_index": null,
        "created_at": "2020-10-03T20:20:43.547Z",
        "updated_at": "2020-10-03T20:20:43.547Z",
        "team_name": "Test team"
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/policy-groups?page=1",
    "last": "https://incidents.betterstack.com/api/v2/policy-groups?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

id
string

The ID of the escalation policy group.

type
string

Always policy_group.

attributes.name
string

The name of the group, as shown in the dashboard.

attributes.sort_index
integer or null

The position of the group in your list of escalation policy groups, lower values first. null when no position was set.

attributes.created_at
string

When the group was created, in ISO 8601 format.

attributes.updated_at
string

When the group was last updated, in ISO 8601 format.

attributes.team_name
string

The team the group belongs to.

pagination.first
string

The URL of the first page. Read more about pagination.

pagination.last
string

The URL of the last page.

pagination.prev
string or null

The URL of the previous page, or null on the first page.

pagination.next
string or null

The URL of the next page, or null on the last page.

Example cURL

Example
curl --request GET \
  --url https://incidents.betterstack.com/api/v2/policy-groups \
  --header "Authorization: Bearer $TOKEN"


Previous article

Remove escalation policy

Next article

Get escalation policy group