API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate provider credentials
- DELDelete provider credentials
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETRetrieve subscriber notifications
- GETRetrieve unseen notifications count
- POSTMark a subscriber feed message as seen
- POSTUpdate all notifications state
- POSTUpdate notification action status
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Tenants
Get tenants
Returns a list of tenants, could paginated using the page
and limit
query parameter
GET
/
v1
/
tenants
import { Novu } from "@novu/api";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.tenants.list(7685.78, 10);
for await (const page of result) {
// handle page
}
}
run();
{
"page": 123,
"hasMore": true,
"pageSize": 123,
"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
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Response
200
application/json
The response is of type object
.
Was this page helpful?
import { Novu } from "@novu/api";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.tenants.list(7685.78, 10);
for await (const page of result) {
// handle page
}
}
run();
{
"page": 123,
"hasMore": true,
"pageSize": 123,
"data": [
{
"_id": "<string>",
"identifier": "<string>",
"name": "<string>",
"data": {},
"_environmentId": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.