Brevo connection
Check the connected account and the access last verified for its key.
The APIs on this page require alpha access for your organization. App availability and API access are separate. Check access and permissions.
Request
GET /v1/brevo-integration/connection
Gets whether Brevo is connected to Neon Deer and its key works, the Brevo account, what the key could read when it was last checked, and what the plan includes. The Brevo API key is added in Neon Deer at connect_url; nothing here returns it.
Requires brevo:config:read. The connection also needs access to the relevant tables, objects, or workflows.
MCP action: get_brevo_connection. Its arguments use the names below, except fields marked REST only. An HTTP header is passed using its argument name in MCP.
No request parameters are needed.
Response
| HTTP status | Result |
|---|---|
200 |
The requested result. Asynchronous work returns an operation to poll. |
Required fields are required within their containing object. Notes identify fields that apply only to a particular response alternative.
| Response field | Type | Required in object | Notes |
|---|---|---|---|
data |
object | Yes | |
data.object |
"brevo_connection" |
Yes | |
data.state |
"connected", "invalid_key", "not_connected" |
Yes | |
data.account |
object or null | Yes | |
data.account.id |
string | Yes | Alternative 1. |
data.account.name |
string | Yes | Alternative 1. |
data.access |
object or null | Yes | |
data.access.checked_at |
string | Yes | Alternative 1. |
data.access.checks |
array of object | Yes | Alternative 1. |
data.access.checks[].resource |
"account", "contacts", "email", "sms", "whatsapp", "email_campaigns", "sms_campaigns", "whatsapp_campaigns", "webhooks" |
Yes | Alternative 1. |
data.access.checks[].state |
"read_verified", "denied", "unavailable" |
Yes | Alternative 1. |
data.plan |
object | Yes | |
data.plan.contact_import |
boolean | Yes | |
data.plan.engagement_activities |
boolean | Yes | |
data.plan.activity_backfill |
boolean | Yes | |
data.connect_url |
string | Yes |
Errors
| HTTP status | Meaning |
|---|---|
400 |
One of: credential_in_url, invalid_parameter, unknown_parameter. |
401 |
One of: missing_credential, invalid_credential, credential_expired, credential_revoked. |
402 |
One of: payment_overdue. |
403 |
The current permissions, plan or policy do not allow this request. |
404 |
One of: not_found. |
409 |
The request conflicts with current resource state, authorization or an earlier request. Read the error code and current resource before retrying. |
410 |
The requested resource or retained recovery data has expired. |
412 |
One of: version_conflict. |
413 |
One of: request_too_large. |
422 |
A field, filter or selection cannot be used for this request. |
423 |
One of: organization_reopening. |
428 |
One of: customer_agreement_required. |
429 |
One of: rate_limited. |
503 |
One of: service_unavailable. |
See errors and recovery and safe retries before repeating a write.
The public OpenAPI document lists generally available API families. Alpha operations may not appear in that document; their request and response fields are listed on this page. Use the API Playground to inspect a real response with your connection's access.