Search for subscribers

GET

subscribers

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Headers

idempotency-key

string

A header for idempotency purposes

Query Parameters

after

string

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

before

string

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

string

Email address of the subscriber to filter results.

name

string

Name of the subscriber to filter results.

phone

string

Phone number of the subscriber to filter results.

subscriberId

string

Unique identifier of the subscriber to filter results.

limit

number

orderDirection

enum<string>

Available options:

ASC,

DESC

orderBy

any

Response

200 - application/json

data

object[]

required

List of returned Subscribers

data._environmentId

string

required

The unique identifier of the environment associated with this subscriber.

data._organizationId

string

required

The unique identifier of the organization to which the subscriber belongs.

data.createdAt

string

required

The timestamp indicating when the subscriber was created, in ISO 8601 format.

data.deleted

boolean

required

Indicates whether the subscriber has been deleted.

data.subscriberId

string

required

The identifier used to create this subscriber, which typically corresponds to the user ID in your system.

data.updatedAt

string

required

The timestamp indicating when the subscriber was last updated, in ISO 8601 format.

data.__v

number

The version of the subscriber document.

data._id

string

The internal ID generated by Novu for your subscriber. This ID does not match the subscriberId used in your queries. Refer to subscriberId for that identifier.

data.avatar

string

The URL of the subscriber's avatar image.

data.channels

object[]

An array of channel settings associated with the subscriber.

data.data

object | null

Additional custom data for the subscriber

data.email

string | null

The email address of the subscriber.

data.firstName

string

The first name of the subscriber.

data.isOnline

boolean

Indicates whether the subscriber is currently online.

data.lastName

string

The last name of the subscriber.

data.lastOnlineAt

string

The timestamp indicating when the subscriber was last online, in ISO 8601 format.

data.locale

string

The locale setting of the subscriber, indicating their preferred language or region.

data.phone

string

The phone number of the subscriber.

data.timezone

string

Timezone of the subscriber

data.topics

string[]

deprecated

An array of topics that the subscriber is subscribed to.

string | null

required

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

string | null

required

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

Was this page helpful?

Suggest edits Raise issue

Handle chat oauth Create subscriber

API Reference

Events

Notifications

Integrations

Subscribers

Messages

Topics

Search for subscribers

Authorizations

Headers

Query Parameters

Response