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
Integrations
List all integrations
List all the channels integrations created in the organization
GET
/
v1
/
integrations
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.getAll();
{
_id: "_id",
_environmentId: "_environmentId",
_organizationId: "_organizationId",
name: "name",
identifier: "identifier",
providerId: "providerId",
channel: "channel",
credentials: credentials,
active: true,
deleted: true,
deletedAt: "deletedAt",
deletedBy: "deletedBy",
primary: true
}
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>');
await novu.integrations.getAll();
{
_id: "_id",
_environmentId: "_environmentId",
_organizationId: "_organizationId",
name: "name",
identifier: "identifier",
providerId: "providerId",
channel: "channel",
credentials: credentials,
active: true,
deleted: true,
deletedAt: "deletedAt",
deletedBy: "deletedBy",
primary: true
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Response
200
application/json
The list of integrations belonging to the organization that are successfully returned.
The response is of type object[]
.
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.integrations.getAll();
{
_id: "_id",
_environmentId: "_environmentId",
_organizationId: "_organizationId",
name: "name",
identifier: "identifier",
providerId: "providerId",
channel: "channel",
credentials: credentials,
active: true,
deleted: true,
deletedAt: "deletedAt",
deletedBy: "deletedBy",
primary: true
}
Assistant
Responses are generated using AI and may contain mistakes.