Skip to main content

List subscribers of a topic

POST 

/api/v1/notifications/manage/list-topic-subscribers

Returns the first page of user IDs subscribed to the selected topic, bounded by page_size. The page field does not advance the result, and no continuation cursor is returned. A true has_more value does not provide a way to retrieve the next page through this operation.

The following access conditions are preserved as declared intent and are not implemented by generated code: Authorized scoped domain action.

Use this in a guide: Broadcast with topics

Request​

Responses​

Topic subscribers listed

Schema-valid request illustration; replace example identifiers and confirm operation prerequisites.​

Section ID: DOC-CP-notifications-api-listTopicSubscribers#example-notifications-listTopicSubscribers-request

Request example

{
"topicKey": "example_123"
}

Illustrative response shape; omitted default fields and actual outcomes depend on the operation.​

Section ID: DOC-CP-notifications-api-listTopicSubscribers#example-notifications-listTopicSubscribers-response

Response example

{
"userIds": [
"example_123"
],
"totalCount": 1,
"hasMore": true
}

Document ID: DOC-CP-notifications-api-listTopicSubscribers. Section identities and revisions.

SectionStable reference
List subscribers of a topicDOC-CP-notifications-api-listTopicSubscribers#overview
RequestDOC-CP-notifications-api-listTopicSubscribers#request
ResponsesDOC-CP-notifications-api-listTopicSubscribers#responses