Get subscribers

GET

subscribers

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_SECRET_KEY>";
Novu novu = new Novu(apiKey);

        Integer page = 0;
        Integer limit = 10;

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

}

{
  "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"
}

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

E.g ApiKey 18d2e625f05d80e

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_SECRET_KEY>";
Novu novu = new Novu(apiKey);

        Integer page = 0;
        Integer limit = 10;

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

}

{
  "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"
}

Authorizations

Authorization

string

headerrequired

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

Query Parameters

page

number

limit

number

default: 10

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

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

string

The first name of the subscriber.

data.lastName

string

The last name of the subscriber.

data.email

string

The email address of the subscriber.

data.phone

string

The phone number of the subscriber.

data.avatar

string

The URL of the subscriber's avatar image.

data.locale

string

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

data.subscriberId

string

required

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

data.channels

object[]

An array of channel settings associated with the subscriber.

data.topics

string[]

An array of topics that the subscriber is subscribed to.

data.isOnline

boolean

Indicates whether the subscriber is currently online.

data.lastOnlineAt

string

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

data._organizationId

string

required

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

data._environmentId

string

required

The unique identifier of the environment associated with this subscriber.

data.deleted

boolean

required

Indicates whether the subscriber has been deleted.

data.createdAt

string

required

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

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.

Was this page helpful?

Cancel triggered event Create subscriber

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_SECRET_KEY>";
Novu novu = new Novu(apiKey);

        Integer page = 0;
        Integer limit = 10;

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

}

{
  "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"
}

API Reference

Authorizations

Query Parameters

Response