---
title: "List subscribers"
method: GET
path: "/stakeholder-comms/cloudId/{cloudId}/api/subscribers/list"
tags: ["Status Page"]
---

# List subscribers

`GET /stakeholder-comms/cloudId/{cloudId}/api/subscribers/list`

Get a list of subscribers for a status page item.

## Query parameters

- `itemType` string, required
- `itemId` string, required

## Response `200`

Returned if the request is successful.

- StakeholderCommsSubscriberConnectionResponse — Response containing a connection-style list of subscribers.
  - `connection` StakeholderCommsSubscriberConnection — Connection-style response for listing subscribers.
    - `nodes` StakeholderCommsSubscriber[]
      - `id` string — Identifier of the subscriber.
      - `itemId` string — Identifier of the subscribed item (page, incident, component).
      - `type` 'INCIDENT_SUBSCRIBER' | 'PAGE_SUBSCRIBER' | 'COMPONENT_SUBSCRIBER' — Subscription item type.
      - `status` 'PENDING_CONFIRMATION' | 'SUBSCRIBED' | 'UNSUBSCRIBED' | 'SUSPENDED' | 'DEACTIVATED' | 'QUARANTINED' | 'UNVERIFIED' — Status of the subscriber.
      - `email` string — Email address of the subscriber.
      - `phoneNumber` string — Phone number for SMS notifications.
      - `phoneCountry` string — Country code for the phone number.
      - `componentIds` string[] — Component identifiers the subscriber is interested in.
      - `webhookEndpoint` string — Webhook URL for notifications.
      - `skipConfirmation` boolean — Whether email confirmation was skipped.
      - `pageAccessUserId` string — Page-access user identifier.
      - `phoneNumberDisplay` string — Formatted phone number for display.
      - `deactivatedAt` string, date-time — When the subscriber was deactivated.
      - `orphanedAt` string, date-time — When the subscriber became orphaned.
      - `quarantinedAt` string, date-time — When the subscriber was quarantined.
      - `confirmedAt` string, date-time — When the subscriber confirmed their subscription.
      - `confirmationCode` string — Confirmation code sent to the subscriber.
      - `shortCodeSubscriptionId` string — Short code subscription identifier.
      - `lastRemindedAt` string, date-time — When the last reminder was sent.
      - `subscriptionType` 'EMAIL' | 'SMS' | 'WEBHOOK' | 'SLACK' — Subscription channel.
      - `additionalInformation` string[] — Additional information strings for the subscription.
      - `slackChannelId` string — Slack channel identifier.
      - `slackUserId` string — Slack user identifier.
      - `createdAt` string, date-time — When the subscriber was created.
      - `updatedAt` string, date-time — When the subscriber was last updated.
    - `pageInfo` object — Pagination information.
      - `hasNextPage` boolean — Whether there is another page of results.
      - `endCursor` string — Cursor for the end of the current page.
    - `totalCount` integer — Total number of subscribers matching the filter.
  - `error` string — Error message, if the operation was not successful.

## Other responses

- `400` — Returned if the request is invalid.
- `401` — Returned if the authentication credentials are incorrect.
- `403` — Returned if the user does not have permission to list subscribers.
- `500` — Returned if an internal server error occurs.

---

[API](https://skmtc.net/atlassian/apis/jsm-operations-api.md) · [All operations](https://skmtc.net/atlassian/apis/jsm-operations-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/atlassian/jsm-operations-api/versions/ed65f017bcb8/schema)