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
Organizations
Fetch all members of current organizations
GET
/
v1
/
organizations
/
members
import { Novu } from "@novu/api";
const novu = new Novu({
apiKey: "<YOUR_API_KEY_HERE>",
});
async function run() {
const result = await novu.organizations.members.list();
// Handle the result
console.log(result)
}
run();
[
{
"_id": "<string>",
"_userId": "<string>",
"user": {
"_id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>"
},
"roles": "admin",
"invite": {
"email": "<string>",
"token": "<string>",
"invitationDate": "2023-11-07T05:31:56Z",
"answerDate": "2023-11-07T05:31:56Z",
"_inviterId": "<string>"
},
"memberStatus": "new",
"_organizationId": "<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
Ok
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.organizations.members.list();
// Handle the result
console.log(result)
}
run();
[
{
"_id": "<string>",
"_userId": "<string>",
"user": {
"_id": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>"
},
"roles": "admin",
"invite": {
"email": "<string>",
"token": "<string>",
"invitationDate": "2023-11-07T05:31:56Z",
"answerDate": "2023-11-07T05:31:56Z",
"_inviterId": "<string>"
},
"memberStatus": "new",
"_organizationId": "<string>"
}
]
Assistant
Responses are generated using AI and may contain mistakes.