Get subscribers

Returns a list of subscribers, could paginated using the page and limit query parameter

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization

string

header

required

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

Query Parameters

page

number

limit

number

default:

10

Required range: x < 100

Response

200 - application/json

data

object[]

required

The list of items matching the query

Show child attributes

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.

Show child attributes

data.channels._integrationId

string

required

The unique identifier of the integration associated with this channel.

data.channels.credentials

object

required

Credentials payload for the specified provider

Show child attributes

data.channels.credentials.webhookUrl

string

required

Webhook url used by chat app integrations. The webhook should be obtained from the chat app provider.

data.channels.credentials.alertUid

string

alert_uid for grafana on-call webhook payload

data.channels.credentials.channel

string

Channel specification for Mattermost chat notifications

data.channels.credentials.deviceTokens

string[]

Contains an array of the subscriber device tokens for a given provider. Used on Push integrations

data.channels.credentials.externalUrl

string

link_to_upstream_details property fo grafana on call webhook

data.channels.credentials.imageUrl

string

image_url property fo grafana on call webhook

data.channels.credentials.state

string

state property fo grafana on call webhook

data.channels.credentials.title

string

title to be used with grafana on call webhook

data.channels.providerId

enum<string>

required

The provider identifier for the credentials

Available options:

slack,

discord,

msteams,

mattermost,

ryver,

zulip,

grafana-on-call,

getstream,

rocket-chat,

whatsapp-business,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

data.channels.integrationIdentifier

string

The integration identifier

data.email

string

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.topics

string[]

An array of topics that the subscriber is subscribed to.

hasMore

boolean

required

Does the list have more items to fetch

page

number

required

The current page of the paginated response

pageSize

number

required

Number of items on each page