- API Reference
- Discord Support
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerid
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preference
- GETGet in app notification feed for a particular subscriber
- GETGet the unseen in app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read unread seen or unseen optionally you can pass feed id or array to mark messages of a particular feed
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Subscribers
Get subscriber
GET
/
v1
/
subscribers
/
{subscriberId}
Authorization
string
*
Authorization
Required
string
subscriberId
string
*
subscriberId
Required
string
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
Path Parameters
subscriberId
string
requiredResponse
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
requiredThe 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.channels.providerId
enum<string>
requiredThe provider identifier for the credentials
Available options:
slack, discord, msteams, mattermost, ryver, zulip, grafana-on-call, getstream, rocket-chat, fcm, apns, expo, one-signal, pushpad, push-webhook, pusher-beams data.channels.integrationIdentifier
string
The integration identifier
data.channels.credentials
object
requiredCredentials payload for the specified provider
data.channels.credentials.webhookUrl
string
requiredWebhook url used by chat app integrations. The webhook should be obtained from the chat app provider.
data.channels.credentials.channel
string
Channel specification for Mattermost chat notifications
data.channels.credentials.deviceTokens
string[]
Contains an array of the subscriber device tokens for a given provider. Used on Push integrations
data.channels.credentials.alertUid
string
alert_uid for grafana on-call webhook payload
data.channels.credentials.title
string
title to be used with grafana on call webhook
data.channels.credentials.imageUrl
string
image_url property fo grafana on call webhook
data.channels.credentials.state
string
state property fo grafana on call webhook
data.channels.credentials.externalUrl
string
link_to_upstream_details property fo grafana on call webhook
data.channels._integrationId
string
requiredId of the integration that is used for this channel
data.isOnline
boolean
data.lastOnlineAt
string
data._organizationId
string
requireddata._environmentId
string
requireddata.deleted
boolean
requireddata.createdAt
string
requireddata.updatedAt
string
requireddata.__v
number
Was this page helpful?
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"
}
}