Skip to Content
Uptimeify Docs
Status pages

List Status Page Subscribers

Returns the email and RSS subscribers of a status page, plus exact counts by status. Organization-wide: admin or editor; customer-bound: by the page's ownership class.

GET /api/status-pages/:id/subscribers

Access: Organization-wide callers need the role admin or editor (organization-wide readonly stays read-only). Customer-bound users (also with the role readonly) and customer-bound API tokens follow the page's ownership class instead: allowed on self_service pages, on managed pages only with the customer's canEditManaged exception, otherwise 403 with data.code: managed_by_organization. Subscriber addresses are personal data, so reading them takes the same right as changing the page.

Path Parameter

ParameterDescription
idStatus page ID or publicId (UUID)

Example (cURL)

curl "$BASE_URL/api/status-pages/db58058e-4b58-4d97-a314-3bb8e279a182/subscribers" \
  -H "Authorization: Bearer $TOKEN"

Response

{
  "total": 12,
  "confirmed": 9,
  "pending": 2,
  "unsubscribed": 1,
  "disabled": 0,
  "subscribers": [
    {
      "id": 42,
      "email": "reader@example.com",
      "channel": "email",
      "target": null,
      "componentIds": null,
      "status": "confirmed",
      "locale": "en",
      "createdAt": "2026-08-01T12:00:00.000Z",
      "confirmedAt": "2026-08-01T12:05:00.000Z"
    },
    {
      "id": 43,
      "email": null,
      "channel": "slack",
      "target": "https://hooks.slack.com/…",
      "componentIds": [12],
      "status": "confirmed",
      "locale": "de",
      "createdAt": "2026-10-27T09:00:00.000Z",
      "confirmedAt": "2026-10-27T09:01:00.000Z"
    }
  ]
}

status is one of pending, confirmed, unsubscribed, or disabled (a webhook, Slack, Teams, SMS or push subscription switched off after 5 failed deliveries in a row). channel is email, sms, push, webhook, slack or teams; email is null for all but email, and target then carries the origin of the target URL or push endpoint only, never the full URL (the URL of an incoming webhook is the credential), or for sms the number as country code and last two digits (+49…67). componentIds lists the components of this page the subscriber follows, null for the whole page. confirmedAt is null until the subscriber confirms. total, confirmed, pending, unsubscribed, and disabled are exact counts computed independently of the subscribers array; subscribers itself is capped at 5000 rows, newest first, use Export Status Page Subscribers to retrieve every row on a larger page.

Common errors

  • 401 Unauthorized when you are not authenticated
  • 400 User must belong to an organization (data.code: userMustBelongToOrg) when no organization can be derived from the session or token
  • 403 Forbidden when you are an organization-wide caller without the role admin or editor, or your customer scope does not include this status page
  • 403 Forbidden (managed_by_organization) when you are customer-bound (user, also with the role readonly, or token) and the page is managed without the customer's canEditManaged exception
  • 400 Invalid Status page identifier when id is not a valid numeric ID or UUID (no data.code)
  • 404 Status page not found when id is well-formed but no status page has that ID (no data.code)
  • 404 Status page not found (data.code: statusPageNotFound) when id resolves to a real status page, but it belongs to a different organization, or is outside your customer scope

The last two rows share the same message but differ in data.code: a malformed or entirely unknown id never carries a data.code; only an id that resolves to a row you may not see does.

On this page