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
    4. Heartbeats
    5. On-call & incidents
    6. Status pages
      1. Status pages API
      2. Status page groups
        1. List status page groups GET
        2. Get status page group GET
        3. List status pages in group GET
        4. Create status page group POST
        5. Update status page group PATCH
        6. Remove status page group DELETE
      3. Status page sections
      4. Status page resources
      5. Status page subscribers
      6. Status page reports
      7. Status page report updates
    7. Metadata
    8. Integrations
    9. Team members
    10. Organization roles
    11. Usage
    12. Reporting

List status page groups

Returns a list of all your status page groups.

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

Query parameters

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 status page groups.

Response body

{
  "data": [
    {
      "id": "1372854",
      "type": "status_page_group",
      "attributes": {
        "name": "Testing group",
        "created_at": "2024-11-07T11:33:24.408Z",
        "updated_at": "2024-11-07T11:33:24.408Z",
        "sort_index": null
      }
    },
    {
      "id": "1372963",
      "type": "status_page_group",
      "attributes": {
        "name": "Testing group 2",
        "created_at": "2024-11-07T12:40:52.278Z",
        "updated_at": "2024-11-07T12:40:52.278Z",
        "sort_index": null
      }
    },
    {
      "id": "1372965",
      "type": "status_page_group",
      "attributes": {
        "name": "Testing group 3",
        "created_at": "2024-11-07T12:42:52.369Z",
        "updated_at": "2024-11-07T12:42:52.369Z",
        "sort_index": null
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/status-page-groups?page=1",
    "last": "https://incidents.betterstack.com/api/v2/status-page-groups?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

id
string

The ID of the status page group.

type
string

Always status_page_group.

attributes.name
string

Name of the group that you can see in the dashboard.

attributes.sort_index
integer or null

Position of the group in your list of status page groups, lower values first. null when not 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.

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/status-page-groups \
  --header "Authorization: Bearer $TOKEN"


Previous article

Remove status page

Next article

Get status page group