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

​
Authorization
string
header
required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Response

200
application/json
Ok
​
_id
string
required
​
_userId
string
required
​
_organizationId
string
required
​
user
object
​
roles
enum<string>
Available options:
admin,
member
​
invite
object
​
memberStatus
enum<string>
Available options:
new,
active,
invited

Was this page helpful?