v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Status Pages

List status pages

Lists all status pages for the organization.

get/api/v2/statuspages

Query parameters

page[offset]integer

Offset to use as the start of the page.

page[limit]integer

The number of status pages to return per page.

filter[domain_prefix]string

Filter status pages by exact domain prefix match. Returns at most one result.

includestring

Comma-separated list of resources to include. Supported values: created_by_user, last_modified_by_user.

Response

Example response

{
  "data": [
    {
      "attributes": {
        "components": [
          {
            "components": [
              {
                "type": "component"
              }
            ],
            "type": "component"
          }
        ],
        "type": "public",
        "visualization_type": "bars_and_uptime_percentage"
      },
      "relationships": {
        "created_by_user": {
          "data": {
            "type": "users"
          }
        },
        "last_modified_by_user": {
          "data": {
            "type": "users"
          }
        }
      },
      "type": "status_pages"
    }
  ],
  "included": [
    {
      "type": "users"
    }
  ],
  "meta": {
    "page": {
      "first_offset": 0,
      "last_offset": 900,
      "limit": 100,
      "next_offset": 100,
      "offset": 0,
      "prev_offset": 100,
      "total": 1000,
      "type": "offset_limit"
    }
  }
}