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.
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".
Headers
A header for idempotency purposes
Query Parameters
Cursor for pagination indicating the starting point after which to fetch results.
Cursor for pagination indicating the ending point before which to fetch results.
Limit the number of items to return
Direction of sorting
ASC, DESC Field to order by
Include cursor item in response
Email address of the subscriber to filter results.
Name of the subscriber to filter results.
Phone number of the subscriber to filter results.
Unique identifier of the subscriber to filter results.
Response
OK
List of returned Subscribers
The cursor for the next page of results, or null if there are no more pages.
The cursor for the previous page of results, or null if this is the first page.
The total count of items (up to 50,000)
Whether there are more than 50,000 results available