Check admin user permissions | Brevo API Documentation

import { BrevoClient } from "@getbrevo/brevo";
async function main() {
    const client = new BrevoClient({
        apiKey: "YOUR_API_KEY_HERE",
    });
    await client.masterAccount.getCorporateUserPermission("email");
}
main();

{
  "email": "invitedUser@company.com",
  "feature_access": {
    "analytics": [
      "download_data",
      "create_alerts",
      "my_looks",
      "explore_create"
    ],
    "api_keys": [
      "all"
    ],
    "apps_management": [
      "all"
    ],
    "create_sub_organizations": [
      "all"
    ],
    "manage_sub_organizations": [
      "all"
    ],
    "my_plan": [
      "all",
      "all"
    ],
    "sub_organization_groups": [
      "create",
      "edit_delete"
    ],
    "user_management": [
      "none"
    ]
  },
  "groups": [
    {
      "id": "6543ab3667ffbb00142e4486",
      "name": "Support"
    },
    {
      "id": "174bab366732bbce142e4412",
      "name": "Technical"
    }
  ],
  "status": "active"
}

This endpoint will provide the list of admin user permissions

Authentication

api-keystring

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

Path parameters

emailstringRequired

Email of the invited user.

Response

List of user's permissions

emailstring

Email address of the user.

feature_accessobject

Granular feature permissions given to the user.

groupslist of objects

statusstring

Status of the invited user.

Errors

400

Bad Request Error