Get subscriber

GET

subscribers

{subscriberId}

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

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

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

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

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

E.g ApiKey 18d2e625f05d80e

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

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

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

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

headerrequired

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

Path Parameters

subscriberId

string

required

Query Parameters

includeTopics

string

Includes the topics associated with the subscriber

Response

200 - application/json

data

object

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

string

required

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

data.channels

object[]

Channels settings for subscriber

data.topics

string[]

Topics that subscriber belongs to

data.isOnline

boolean

data.lastOnlineAt

string

data._organizationId

string

required

data._environmentId

string

required

data.deleted

boolean

required

data.createdAt

string

required

data.updatedAt

string

required

data.__v

number

Was this page helpful?

Bulk create subscribers Update subscriber

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

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

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

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