Skip to main content
GET
/
v1
/
subscribers
/
{subscriberId}
import { Novu } from '@novu/node';

const novu = new Novu("<NOVU_API_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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://v0.x-docs.novu.co/llms.txt

Use this file to discover all available pages before exploring further.

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_API_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
header
required

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

Path Parameters

​
subscriberId
string
required

Response

Ok

​
subscriberId
string
required

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

​
_organizationId
string
required
​
_environmentId
string
required
​
deleted
boolean
required
​
createdAt
string
required
​
updatedAt
string
required
​
_id
string

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

​
firstName
string
​
lastName
string
​
email
string
​
phone
string
​
avatar
string
​
locale
string
​
channels
object[]

Channels settings for subscriber

​
isOnline
boolean
​
lastOnlineAt
string
​
__v
number