Tenants
Get tenant
- 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 preferences
- 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
Tenants
Get tenant
Get tenant by your internal id used to identify the tenant
GET
/
v1
/
tenants
/
{identifier}
Authorization
string
*
Authorization
Required
string
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
identifier
string
*
identifier
Required
string
curl --request GET \
--url https://api.novu.co/v1/tenants/{identifier} \
--header 'Authorization: <api-key>'
{
"data": {
"_id": "<string>",
"identifier": "<string>",
"name": "<string>",
"data": {},
"_environmentId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Authorizations
Authorization
string
headerrequiredAPI key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
identifier
string
requiredResponse
200 - application/json
data
object
data._id
string
requireddata.identifier
string
requireddata.name
string
data.data
object
data._environmentId
string
requireddata.createdAt
string
requireddata.updatedAt
string
requiredWas this page helpful?
curl --request GET \
--url https://api.novu.co/v1/tenants/{identifier} \
--header 'Authorization: <api-key>'
{
"data": {
"_id": "<string>",
"identifier": "<string>",
"name": "<string>",
"data": {},
"_environmentId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}