v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Status Pages

Get status page

Retrieves a specific status page by its ID.

get/api/v2/statuspages/{page_id}

Path parameters

page_idstring uuid required

Example:1234abcd-12ab-34cd-56ef-123456abcdef

The ID of the status page.

Query parameters

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"
    }
  ]
}