How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Brevo User API

The user API from Brevo — 6 operation(s) for user.

Brevo User API is one of 53 APIs that Brevo publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 6 operations across 6 paths, and defines 26 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.brevo.com/v3.

6 operations 6 paths 26 schemas 2 GET2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.brevo.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Brevo User API declares 1 security scheme for authenticating requests. An API key is passed in the header as api-key (api-key).

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

Paths & Operations 6

Across 6 paths, the API surfaces 6 operations — 2 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

user 6
GET
/organization/invited/users
Get the list of all your users
getInvitedUsersList 1 param → 200400
GET
/organization/user/{email}/permissions
Check user permission
getUserPermission 2 params → 200400
PUT
/organization/user/invitation/revoke/{email}
Revoke user permission
putRevokeUserPermission 2 params → 200403
PUT
/organization/user/invitation/{action}/{email}
Resend / Cancel invitation
putresendcancelinvitation 3 params → 200403
POST
/organization/user/invitation/send
Send invitation to user
inviteuser 1 param body → 200400
POST
/organization/user/update/permissions
Update permission for a user
EditUserPermission 1 param body → 200400

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems (4 properties), User_getUserPermission_Response_200 (3 properties), OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess (3 properties), User_EditUserPermission_Response_200 (3 properties). Each schema is shown below with its type and property counts.

OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItemsFeatureAccess
object
Feature accessiblity given to the user.
3 properties
OrganizationUserUpdatePermissionsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
User_EditUserPermission_Response_200
object
3 properties 1 required
InviteuserRequestBadRequestError
object
2 properties 2 required
OrganizationUserInvitationSendPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
OrganizationUserInvitationRevokeEmailPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaPrivilegesItems
object
2 properties 2 required
EditUserPermissionRequestBadRequestError
object
2 properties 2 required
OrganizationUserInvitationActionEmailPutParametersAction
string
GetUserPermissionRequestBadRequestError
object
2 properties 2 required
InviteuserPrivilegesItems
object
Privileges given to the user
2 properties
GetInvitedUsersListRequestBadRequestError
object
2 properties 2 required
OrganizationUserInvitationActionEmailPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
OrganizationUserEmailPermissionsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
User_getInvitedUsersList_Response_200
object
1 property
User_getUserPermission_Response_200
object
Check user permission
3 properties 3 required
inviteuser
object
3 properties 3 required
User_putresendcancelinvitation_Response_200
object
2 properties 1 required
PutresendcancelinvitationRequestForbiddenError
object
2 properties 2 required
InviteuserPrivilegesItemsPermissionsItems
string
User_inviteuser_Response_200
object
2 properties 1 required
InviteuserPrivilegesItemsFeature
string
Feature name
PutRevokeUserPermissionRequestForbiddenError
object
2 properties 2 required
OrganizationInvitedUsersGetResponsesContentApplicationJsonSchemaUsersItems
object
4 properties 4 required
User_putRevokeUserPermission_Response_200
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

brevo-user-api-openapi.yml Raw ↑

Other APIs Brevo publishes across the network.

brevo Agent Status API
brevo Automated Messages API
brevo Campaign Statistics API
brevo Categories API
brevo Contact Attributes API
brevo Contact Lists API
brevo Contacts API
brevo Email Activity API
brevo Email Campaigns API
brevo Email Templates API
brevo Folders API
brevo Import API
Where this information came from

This is an independent, third-party profile of Brevo User API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.