Get subscribers

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

E.g ApiKey 18d2e625f05d80e

Java

import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.BulkSubscriberResponse;

public class Main {
   public static void main(String[] args) {
        String apiKey = "<NOVU_API_KEY>";
        Novu novu = new Novu(apiKey);

        Integer page = 0;
        Integer limit = 10;

        BulkSubscriberResponse response = novu.getSubscribers(page, limit);
    }
}

Response

{
  "data": [
    {
      "__v": "number",
      "_environmentId": "string",
      "_id": "string",
      "_organizationId": "string",
      "avatar": "string",
      "channels": [
        {
          "_integrationId": "string",
          "credentials": {
            "channel": "string",
            "deviceTokens": [
              "string"
            ],
            "webhookUrl": "string"
          },
          "integrationIdentifier": "string",
          "providerId": "slack"
        }
      ],
      "createdAt": "string",
      "deleted": "boolean",
      "email": "string",
      "firstName": "string",
      "isOnline": "boolean",
      "lastName": "string",
      "lastOnlineAt": "string",
      "locale": "string",
      "phone": "string",
      "subscriberId": "string",
      "updatedAt": "string"
    }
  ],
  "hasMore": "boolean",
  "page": "number",
  "pageSize": "number"
}

Query Parameters

page · number

limit · number · default: 10

Required range: x <= 100

Response

200

application/json

page · number · required

The current page of the paginated response

hasMore · boolean · required

Does the list have more items to fetch

pageSize · number · required

Number of items on each page

data · object[] · required

The list of items matching the query

Show child attributes

data. subscriberId · string · required

The internal identifier you used to create this subscriber, usually correlates to the id the user in your systems

data. _organizationId · string · required

data. _environmentId · string · required

data. deleted · boolean · required

data. createdAt · string · required

data. updatedAt · string · required

data. _id · string

The internal id novu generated for your subscriber, this is not the subscriberId matching your query. See subscriberId for that

data. firstName · string

data. lastName · string

data. email · string

data. phone · string

data. avatar · string

data. locale · string

data. channels · object[]

Channels settings for subscriber

Show child attributes

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,

fcm,

apns,

expo,

one-signal,

pushpad,

push-webhook,

pusher-beams

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. 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. alertUid · string

alert_uid for grafana on-call webhook payload

data.channels.credentials. title · string

title to be used with 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. externalUrl · string

link_to_upstream_details property fo grafana on call webhook

data.channels. _integrationId · string · required

Id of the integration that is used for this channel

data.channels. integrationIdentifier · string

The integration identifier

data. isOnline · boolean

data. lastOnlineAt · string

data. __v · number