v4

OpenAPI 3.0.0MIT2026-07-311554531.6 MB

Subscribers

Search subscribers

Search subscribers by their email, phone, subscriberId and name. The search is case sensitive and supports pagination.Checkout all available filters in the query section.

get/v2/subscribers

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

orderDirection'ASC' | 'DESC'

Direction of sorting

orderBystring

Field to order by

includeCursorboolean

Include cursor item in response

emailstring

Email address of the subscriber to filter results.

namestring

Name of the subscriber to filter results.

phonestring

Phone number of the subscriber to filter results.

subscriberIdstring

Unique identifier of the subscriber to filter results.

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": [
    {
      "channels": [
        {
          "credentials": {
            "webhookUrl": "https://example.com/webhook",
            "channel": "general",
            "deviceTokens": [
              "token1",
              "token2",
              "token3"
            ],
            "alertUid": "12345-abcde",
            "title": "Critical Alert",
            "imageUrl": "https://example.com/image.png",
            "state": "resolved",
            "externalUrl": "https://example.com/details"
          }
        }
      ]
    }
  ]
}