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
    6. Status pages
      1. Status pages API
      2. Status page groups
      3. Status page sections
        1. List status page sections GET
        2. Get status page section GET
        3. Create status page section POST
        4. Update status page section PATCH
        5. Remove status page section DELETE
      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 sections

Returns a list of the sections of your status page.

GET https://incidents.betterstack.com/api/v2/status-pages/{status_page_id}/sections

URL parameters

status_page_id
required string

The ID of your status page.

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 the sections of your status page.

Response body

{
  "data": [
    {
      "id": "12345",
      "type": "status_page_section",
      "attributes": {
        "name": "Current status by service",
        "position": 0,
        "status_page_id": 123456789
      }
    },
    {
      "id": "12345",
      "type": "status_page_section",
      "attributes": {
        "name": "EU datacenter",
        "position": 1,
        "status_page_id": 123456789
      }
    }
  ],
  "pagination": {
    "first": "https://incidents.betterstack.com/api/v2/status-pages/123456789/sections?page=1",
    "last": "https://incidents.betterstack.com/api/v2/status-pages/123456789/sections?page=1",
    "prev": null,
    "next": null
  }
}

Response attributes

id
string

The ID of the status page section.

type
string

Always status_page_section.

attributes.name
string or null

Name of the section. When blank, the section header is hidden.

attributes.position
integer

Position of the section on the status page, counted from the top and starting at 0.

attributes.status_page_id
integer

ID of the status page the section 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/status-pages/123456789/sections \
  --header "Authorization: Bearer $TOKEN"


Previous article

Remove status page group

Next article

Get status page section