NOnovu
Subscribers

Search subscribers

Changed on

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

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

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
Example:10

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

Exact email address of the subscriber. The value must match the stored email field.

namestring

Name of the subscriber to filter results.

phonestring

Exact phone number of the subscriber. The value must match the stored phone field.

subscriberIdstring

Unique identifier of the subscriber to filter results.

Headers

idempotency-keystring

A header for idempotency purposes

Response

OK

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

  • f056922796adRevision changes
    • warning

      added the new google-chat enum value to the //// response property for the response status

    • warning

      added the new photon-imessage enum value to the //// response property for the response status

  • 24e82408dec7Revision changes
    • warning

      added the new novu-web-chat enum value to the //// response property for the response status

    • info

      removed the novu-agent-chat enum value from the //// response property for the response status