Skip to main content
GET
/
v1
/
status-pages
Retrieve all status pages.
curl --request GET \
  --url https://api.checklyhq.com/v1/status-pages \
  --header 'Authorization: Bearer <token>'
{
  "length": 123,
  "entries": [
    {
      "name": "<string>",
      "url": "<string>",
      "id": "<string>",
      "accountId": "<string>",
      "created_at": "2023-12-25",
      "customDomain": "<string>",
      "themeColors": {
        "light": {
          "bodyBackgroundColor": "<string>",
          "headerBackgroundColor": "<string>",
          "headerFontColor": "<string>",
          "titleFontColor": "<string>",
          "bodyFontColor": "<string>",
          "bodyFontColorMuted": "<string>",
          "navigationFontColor": "<string>",
          "linkFontColor": "<string>",
          "cardBackgroundColor": "<string>",
          "borderColor": "<string>",
          "primaryButtonBackgroundColor": "<string>",
          "primaryButtonFontColor": "<string>"
        },
        "dark": {
          "bodyBackgroundColor": "<string>",
          "headerBackgroundColor": "<string>",
          "headerFontColor": "<string>",
          "titleFontColor": "<string>",
          "bodyFontColor": "<string>",
          "bodyFontColorMuted": "<string>",
          "navigationFontColor": "<string>",
          "linkFontColor": "<string>",
          "cardBackgroundColor": "<string>",
          "borderColor": "<string>",
          "primaryButtonBackgroundColor": "<string>",
          "primaryButtonFontColor": "<string>"
        }
      },
      "logo": "<string>",
      "redirectTo": "<string>",
      "favicon": "<string>",
      "defaultTheme": "AUTO",
      "cards": [
        {
          "id": "<string>",
          "name": "<string>",
          "created_at": "2023-12-25",
          "services": [
            {
              "name": "<string>",
              "id": "<string>",
              "accountId": "<string>",
              "created_at": "2023-12-25",
              "updated_at": "2023-12-25",
              "checks": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          ],
          "updated_at": "2023-12-25"
        }
      ],
      "updated_at": "2023-12-25",
      "incidents": [
        {
          "name": "<string>",
          "severity": "CRITICAL",
          "id": "<string>",
          "services": [
            {
              "name": "<string>",
              "id": "<string>",
              "accountId": "<string>",
              "created_at": "2023-12-25",
              "updated_at": "2023-12-25",
              "checks": [
                {
                  "id": "<string>",
                  "name": "<string>"
                }
              ]
            }
          ],
          "lastUpdateStatus": "INVESTIGATING",
          "created_at": "2023-12-25",
          "incidentUpdates": [
            {
              "description": "<string>",
              "id": "<string>",
              "created_at": "2023-12-25",
              "status": "INVESTIGATING",
              "publicIncidentUpdateDate": "2025-12-05T02:37:44.791Z",
              "notifySubscribers": false
            }
          ],
          "updated_at": "2023-12-25"
        }
      ]
    }
  ],
  "nextId": "<string>"
}

Authorizations

​
Authorization
string
header
required

The Checkly Public API uses API keys to authenticate requests. You can get the API Key here. Your API key is like a password: keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set Authorization header while using cURL: curl -H "Authorization: Bearer [apiKey]" "X-Checkly-Account: [accountId]"

Headers

​
x-checkly-account
string

Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general

Query Parameters

​
limit
integer
default:20
Required range: 1 <= x <= 100
​
nextId
string

Response

Successful

​
length
integer
required
​
entries
object[]
required
​
nextId
string | null