Skip to main content
GET
/
v1
/
status-pages
/
{statusPageId}
/
subscriptions
Get all subscriptions for a specific status page
curl --request GET \
  --url https://api.checklyhq.com/v1/status-pages/{statusPageId}/subscriptions \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "type": "EMAIL",
    "address": "<string>",
    "status": "PENDING",
    "created_at": "2023-12-25",
    "updated_at": "2023-12-25"
  }
]

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

Path Parameters

​
statusPageId
string
required

Response

The list of subscriptions for the status page.

​
id
string
required

The ID of the subscription.

​
type
enum<string>
required

The type of subscription.

Available options:
EMAIL
​
address
string
required

The email address to subscribe to the status page.

​
status
enum<string>
required

The status of the subscription.

Available options:
PENDING,
VERIFIED
​
created_at
string<date>
required

The date the subscription was created.

​
updated_at
string<date>
required

The date the subscription was last updated.

⌘I