GET/v2/statuspages/{uuid}/subscribers

List subscribers

Returns all confirmed subscribers for a status page.

Request

Path Parameters

uuidstringrequired

The status page UUID

Example:"sp_xyz789abc"

Query Parameters

pagenumberoptional

Page number (0-indexed). Default: 0

typeenum<string>optional

Filter by subscriber type. Default: all

Available options:

allemailsmsslackteams

Response

Returns paginated list of subscribers.

Subscriber Object Fieldsapplication/json

idnumber

Unique identifier for the subscriber

typestring

Subscriber type: email, sms, slack, or teams

valuestring

The subscription value (email, phone, etc.)

emailstring

Email address (for email subscribers)

phonestring

Phone number (for SMS subscribers)

slack_channelstring

Slack channel (for Slack subscribers)

created_atstring

ISO 8601 timestamp of when the subscription was created

RequestcURL

curl -X GET "https://api.hyperping.io/v2/statuspages/sp_xyz789abc/subscribers?type=email" \
  -H "Authorization: Bearer ${API_TOKEN}"

200 OKJSON

{
  "subscribers": [
    {
      "id": 12345,
      "type": "email",
      "value": "user@example.com",
      "email": "user@example.com",
      "phone": null,
      "slack_channel": null,
      "created_at": "2025-01-15T10:30:00.000Z"
    }
  ],
  "hasNextPage": false,
  "total": 1,
  "page": 0,
  "resultsPerPage": 20
}

← Delete a status page Add a subscriber →