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"
}
}
Get subscriber by your internal id used to identify the subscriber
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"
}
}
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"
}
}
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Ok
The response is of type object
.
Was this page helpful?