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
      6. Severities
        1. List severities GET
        2. Get severity GET
        3. Create severity POST
        4. Update severity PATCH
        5. Remove severity DELETE
      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 severities

Returns a list of existing severities.

GET https://incidents.betterstack.com/api/v2/urgencies

Query parameters

team_name
string

Filter severities 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 paginated list of severities.

Response body

{
  "data": [
    {
      "id": "123",
      "type": "urgency",
      "attributes": {
        "name": "High Severity",
        "team_name": "Test team",
        "sms": false,
        "call": true,
        "email": true,
        "push": true,
        "critical_alert": false,
        "urgency_group_id": null
      }
    },
    {
      "id": "456",
      "type": "urgency",
      "attributes": {
        "name": "Low Severity",
        "team_name": "Test team",
        "sms": false,
        "call": false,
        "email": true,
        "push": false,
        "critical_alert": false,
        "urgency_group_id": null
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/urgencies?page=1",
    "last": "https://incidents.betterstack.com/api/v2/urgencies?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

id
string

The ID of the severity.

type
string

Always urgency.

attributes.name
string

The name of the severity.

attributes.team_name
string

The team this severity belongs to.

attributes.sms
boolean

Whether to send an SMS when a new incident is created.

attributes.call
boolean

Whether to call when a new incident is created.

attributes.email
boolean

Whether to send an e-mail when a new incident is created.

attributes.push
boolean

Whether to send a push notification when a new incident is created.

attributes.critical_alert
boolean

Whether to send a critical push notification that ignores the mute switch and Do Not Disturb mode.

attributes.urgency_group_id
integer or null

The ID of the severity group the severity belongs to, or null when it is in no group.

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.

Team members can override these channels

Each team member can override the severity's alert channels for themselves in their Alerts settings.

Example cURL

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


Previous article

Remove escalation policy group

Next article

Get severity