- 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 global preferences
GET
/
v1
/
subscribers
/
{subscriberId}
/
preferences
/
{level}
Authorization
string
*
Authorization
Required
string
level
string
*
level
Required
string
subscriberId
string
*
subscriberId
Required
string
curl --request GET \
--url https://api.novu.co/v1/subscribers/{subscriberId}/preferences/{level}
{
"data": [
{
"template": {
"_id": "<string>",
"name": "<string>",
"critical": true,
"triggers": [
"<string>"
]
},
"preference": {
"enabled": true,
"channels": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
}
}
}
]
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Path Parameters
level
string
requiredsubscriberId
string
requiredResponse
200 - application/json
data
object[]
data.template
object
The workflow information and if it is critical or not
data.template._id
string
requiredUnique identifier of the workflow
data.template.name
string
requiredName of the workflow
data.template.critical
boolean
requiredCritical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen
data.template.triggers
string[]
requiredTriggers are the events that will trigger the workflow.
data.preference
object
requiredThe preferences of the subscriber regarding the related workflow
data.preference.enabled
boolean
requiredSets if the workflow is fully enabled for all channels or not for the subscriber.
data.preference.channels
object
requiredSubscriber preferences for the different channels regarding this workflow
data.preference.channels.email
boolean
data.preference.channels.sms
boolean
data.preference.channels.in_app
boolean
data.preference.channels.chat
boolean
data.preference.channels.push
boolean
Was this page helpful?
curl --request GET \
--url https://api.novu.co/v1/subscribers/{subscriberId}/preferences/{level}
{
"data": [
{
"template": {
"_id": "<string>",
"name": "<string>",
"critical": true,
"triggers": [
"<string>"
]
},
"preference": {
"enabled": true,
"channels": {
"email": true,
"sms": true,
"in_app": true,
"chat": true,
"push": true
}
}
}
]
}