Get subscriber

Get subscriber by your internal id used to identify the subscriber

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

E.g ApiKey 18d2e625f05d80e

Node.js

import { Novu } from "@novu/node";

const novu = new Novu("<NOVU_SECRET_KEY>");

const response = await novu.subscribers.get("subscriberId");
console.log(response.data);

Response

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

Authorizations

Authorization · string · header · required

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

Path Parameters

subscriberId · string · required

Query Parameters

includeTopics · boolean

Includes the topics associated with the subscriber

Response

200

application/json

OK

data · object

Show child attributes