List Status Pages
Returns all status pages for the organization. Each page includes its custom domain info if configured.
GET /api/status-pages
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
envelope | string | none | items: answer as { items, total, page, perPage }. Becomes the default on 2027-01-18. |
Example (cURL)
curl -X GET "$BASE_URL/api/status-pages?envelope=items" \
-H "Authorization: Bearer $TOKEN" \
-H "Accept: application/json"Response
{
"items": [
{
"id": 1,
"publicId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"organizationId": 1,
"customerId": 5,
"includeCustomerMonitors": true,
"managementType": "managed",
"canEdit": true,
"customerPublicId": "f7e6d5c4-b3a2-1098-7654-321fedcba098",
"name": "Production Status",
"slug": "production-status",
"description": "Real-time status of our production services",
"visibility": "public",
"isPublished": true,
"showRecentIncidents": true,
"showRecentMaintenance": true,
"customDomainId": null,
"ipAllowlist": [],
"audienceGroups": [],
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
],
"total": 1,
"page": 1,
"perPage": 1
}List form: with envelope=items the list arrives as { items, total, page, perPage }. Without it the endpoint still answers the current form ({ "statusPages": [...] }), which is deprecated; { items, ... } becomes the default on 2027-01-18.
customerId, customerPublicId and customerName are null for a page without a customer. Such a page is visible to organization-wide roles and API tokens only; a customer-scoped caller does not see it. includeCustomerMonitors says whether the customer's monitors appear automatically. The components of a page are read with List Status Page Components and List Status Page Component Groups.
canEdit (since 30 October 2026) says whether you may change this page and what hangs off it (settings, components, custom domain, subscribers, incidents, maintenance). Organization-wide callers: true with the role admin or editor. Customer-bound users and tokens (also with the role readonly): true for self_service pages, for managed pages only when the customer has canEditManaged. It is the same rule the write endpoints apply, see Who may change a status page.
ipAllowlist and audienceGroups (since 28 October 2026) carry the page's IP allowlist (as addr/prefix) and its audience groups (name, emailDomains, componentIds as numeric ids); both are [] when not set.
Compatibility: since 27 October 2026 customerId can be null in responses (a page of the whole organization, without a customer), together with customerPublicId and customerName where present. A client that assumes customerId is always a number must handle null.
Common errors
401 Unauthorizedwhen not authenticated