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

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

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

The response is of type object.