Get the list of all your users

GET

https://api.brevo.com/v3/organization/invited/users

GET

/v3/organization/invited/users

1 import { BrevoClient } from "@getbrevo/brevo";
2 
3 async function main() {
4     const client = new BrevoClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.user.getInvitedUsersList();
8 }
9 main();

1 {
2   "users": [
3     {
4       "email": "owner@company.com",
5       "feature_access": {
6         "conversations": "owner",
7         "crm": "owner",
8         "marketing": "owner"
9       },
10       "is_owner": "true",
11       "status": "active"
12     },
13     {
14       "email": "pendingInvitedUser@company.com",
15       "feature_access": {
16         "conversations": "none",
17         "crm": "full",
18         "marketing": "custom"
19       },
20       "is_owner": "false",
21       "status": "pending"
22     },
23     {
24       "email": "connectedInvitedUser@company.com",
25       "feature_access": {
26         "conversations": "full",
27         "crm": "none",
28         "marketing": "none"
29       },
30       "is_owner": "false",
31       "status": "active"
32     }
33   ]
34 }

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Response

list of all your users

userslist of objects

Get invited users list

Errors

400

Bad Request Error