v4

latestOpenAPI 3.0.0MIT2026-07-311494532.1 MB

Topics

List topic subscriptions

List all subscriptions of subscribers for a topic. Checkout all available filters in the query section.

get/v2/topics/{topicKey}/subscriptions

Path parameters

topicKeystring required

The key identifier of the topic

Query parameters

afterstring

Cursor for pagination indicating the starting point after which to fetch results.

beforestring

Cursor for pagination indicating the ending point before which to fetch results.

limitnumber

Limit the number of items to return (max 100)

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

subscriberIdstring

Filter by subscriber ID

contextKeysstring[]

Filter by exact context keys, order insensitive (format: "type:id")

Headers

idempotency-keystring

A header for idempotency purposes

Response

nextstring nullable required

The cursor for the next page of results, or null if there are no more pages.

previousstring nullable required

The cursor for the previous page of results, or null if this is the first page.

totalCountnumber required

The total count of items (up to 50,000)

totalCountCappedboolean required

Whether there are more than 50,000 results available

Example response

{
  "data": [
    {
      "_id": "64da692e9a94fb2e6449ad08",
      "identifier": "tk=product-updates:si=subscriber-123",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "topic": {
        "_id": "64da692e9a94fb2e6449ad06",
        "key": "product-updates",
        "name": "Product Updates",
        "createdAt": "2023-08-15T00:00:00.000Z",
        "updatedAt": "2023-08-15T00:00:00.000Z"
      },
      "subscriber": {
        "_id": "64da692e9a94fb2e6449ad07",
        "subscriberId": "user-123",
        "avatar": "https://example.com/avatar.png",
        "firstName": "John",
        "lastName": "Doe",
        "email": "john@example.com"
      },
      "contextKeys": [
        "tenant:org-a",
        "project:proj-123"
      ]
    }
  ]
}