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"
          }
        }
      ]
    }
  ]
}

Changes

Changed in 4 of the 13 revisions of this API.62

Aug 30, 20268bc1670bbd1311See the full diff
- ●
  added the new novu-web-chat enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  removed the novu-agent-chat enum value from the //// response property for the response status
  response-property-enum-value-removed
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Aug 16, 2026d7137c47680a11See the full diff
- ●
  added the new novu-agent-chat enum value to the //// response property for the response status
  response-property-enum-value-added
- ○
  removed the novu-web-chat enum value from the //// response property for the response status
  response-property-enum-value-removed
Jul 31, 202647f16ff4d4271See the full diff
- ●
  added the new novu-web-chat enum value to the //// response property for the response status
  response-property-enum-value-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 21, 20262e115ea8160c3See the full diff
- ●
  added the new line enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new sendblue enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new webex-messaging enum value to the //// response property for the response status
  response-property-enum-value-added

Full history