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. AI SRE investigations
    3. Post mortems
    4. Metadata & Catalog
    5. Screening alerts
    6. 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
      1. Monitors API
      2. Monitor groups API
        1. List monitor groups GET
        2. Get monitor group GET
        3. List monitors in group GET
        4. Create monitor group POST
        5. Update monitor group PATCH
        6. Remove monitor group DELETE
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

Get monitor group

Returns a single monitor group by ID.

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

URL parameters

monitor_group_id
required string

The ID of the monitor group you want to get.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a single monitor group.

Response body

{
  "data": {
    "id": "95251342",
    "type": "monitor_group",
    "attributes": {
      "name": "Backend services",
      "sort_index": null,
      "created_at": "2020-10-03T20:20:43.547Z",
      "updated_at": "2020-10-03T20:20:43.547Z",
      "team_name": "Test team",
      "paused": true
    }
  }
}

Response attributes

id
string

The ID of the monitor group.

type
string

Always monitor_group.

attributes.name
string

The name of the group that you can see in the dashboard.

attributes.sort_index
integer or null

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

attributes.paused
boolean

true when the group contains monitors and all of them are paused.

attributes.team_name
string

The team the group is in.

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.

Example cURL

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


Previous article

List monitor groups

Next article

List monitors in group