GET
/
v2
/
subscribers
/
{subscriberId}
TypeScript
import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.retrieve("<id>");

  // Handle the result
  console.log(result);
}

run();
{
  "_id": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "avatar": "<string>",
  "locale": "<string>",
  "subscriberId": "<string>",
  "channels": [
    {
      "providerId": "slack",
      "integrationIdentifier": "<string>",
      "credentials": {
        "webhookUrl": "https://example.com/webhook",
        "channel": "general",
        "deviceTokens": [
          "token1",
          "token2",
          "token3"
        ],
        "alertUid": "12345-abcde",
        "title": "Critical Alert",
        "imageUrl": "https://example.com/image.png",
        "state": "resolved",
        "externalUrl": "https://example.com/details"
      },
      "_integrationId": "<string>"
    }
  ],
  "topics": [
    "<string>"
  ],
  "isOnline": true,
  "lastOnlineAt": "<string>",
  "_organizationId": "<string>",
  "_environmentId": "<string>",
  "deleted": true,
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "__v": 123,
  "data": {}
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
idempotency-key
string

A header for idempotency purposes

Path Parameters

​
subscriberId
string
required

Response

200
application/json

OK

The response is of type object.