brevo Contacts API
Create, retrieve, update, and delete individual contacts.
brevo Contacts 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 Contacts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes 29 operations across 18 paths, and defines 158 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://api.brevo.com/v3.
29 operations
18 paths
158 schemas
5 DELETE11 GET9 POST4 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
brevo Contacts API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as api-key (api-key).
An API key is passed in the header as api-key (apiKeyAuth).
api-key— The API key should be passed in the request headers as api-key for authentication.apiKeyAuth— Brevo API key passed in the api-key request header for authentication.
Paths & Operations 29
Across 18 paths, the API surfaces 29 operations — 5 DELETE, 11 GET, 9 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.
contacts 29
POST
/contacts/attributes/{attributeCategory}/{attributeName}
Create contact attribute
PUT
/contacts/attributes/{attributeCategory}/{attributeName}
Update contact attribute
DELETE
/contacts/attributes/{attributeCategory}/{attributeName}
Delete an attribute
GET
/contacts/attributes
List all attributes
DELETE
/contacts/attributes/{attributeType}/{multipleChoiceAttribute}/{multipleChoiceAttributeOption}
Delete a multiple-choice attribute option
POST
/contacts/lists
Create a list
GET
/contacts/lists
Get all the lists
GET
/contacts/lists/{listId}
Get a list's details
PUT
/contacts/lists/{listId}
Update a list
DELETE
/contacts/lists/{listId}
Delete a list
GET
/contacts/lists/{listId}/contacts
Get contacts in a list
POST
/contacts/lists/{listId}/contacts/remove
Delete a contact from a list
POST
/contacts/lists/{listId}/contacts/add
Add existing contacts to a list
POST
/contacts/folders
Create a folder
GET
/contacts/folders
Get all folders
GET
/contacts/folders/{folderId}
Returns a folder's details
PUT
/contacts/folders/{folderId}
Update a folder
DELETE
/contacts/folders/{folderId}
Delete a folder (and all its lists)
GET
/contacts/folders/{folderId}/lists
Get lists in a folder
GET
/contacts
Get all the contacts
POST
/contacts
Create a contact
POST
/contacts/doubleOptinConfirmation
Create Contact via DOI (Double-Opt-In) Flow
GET
/contacts/{identifier}
Get a contact's details
DELETE
/contacts/{identifier}
Delete a contact
PUT
/contacts/{identifier}
Update a contact
GET
/contacts/{identifier}/campaignStats
Get email campaigns' statistics for a contact
GET
/contacts/segments
Get all the segments
POST
/contacts/export
Export contacts
POST
/contacts/import
Import contacts
Schemas 158
The contract defines 158 schemas that model the data the API accepts and returns. The most detailed are getCampaignStats (18 properties), Contacts_getContactInfo_Response_200 (12 properties), getContactDetails (11 properties), ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatistics (9 properties). Each schema is shown below with its type and property counts.
ContactsListsGetResponsesContentApplicationJsonSchemaListsItems
object
6 properties
6 required
ContactsIdentifierPutParametersIdentifier
createUpdateFolder
object
1 property
Contacts_getLists_Response_200
object
2 properties
ContactsListsListIdContactsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
UpdateAttributeRequestNotFoundError
object
2 properties
2 required
ContactsListsListIdContactsGetParametersSort
string
Contacts_createList_Response_201
object
1 property
1 required
GetContactStatsRequestBadRequestError
object
2 properties
2 required
ContactsExportPostRequestBodyContentApplicationJsonSchemaCustomContactFilter
object
Set the filter for the contacts to be exported.
7 properties
getContactDetails
object
11 properties
8 required
ContactsFoldersGetParametersSort
string
GetContactsRequestBadRequestError
object
2 properties
2 required
Contacts_getContactInfo_Response_200
object
12 properties
9 required
ContactsListsListIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsMessagesSentItems
object
2 properties
2 required
getContacts
object
2 properties
2 required
getList
object
5 properties
5 required
ContactsIdentifierDeleteParametersIdentifier
ContactsSegmentsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierDeleteParametersIdentifierType
string
ContactsGetParametersSort
string
UpdateListRequestBadRequestError
object
2 properties
2 required
Contacts_removeContactFromList_Request
ContactsIdentifierCampaignStatsGetParametersIdentifier
postContactInfo
object
1 property
1 required
ConsentGroupItem
object
A contact's membership status in a single consent group.
2 properties
2 required
CreateListRequestBadRequestError
object
2 properties
2 required
GetContactsFromListRequestBadRequestError
object
2 properties
2 required
ContactsListsListIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteFolderRequestBadRequestError
object
2 properties
2 required
ContactsListsGetParametersSort
string
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsClickedItems
object
2 properties
2 required
ContactsAttributesAttributeCategoryAttributeNamePostRequestBodyContentApplicationJsonSchemaType
string
Type of the attribute. Use only if the attribute's category is 'normal', 'category' or 'transactional' Type user and multiple-choice is only available if the c…
ContactsAttributesAttributeCategoryAttributeNameDeleteParametersAttributeCategory
string
GetListRequestBadRequestError
object
2 properties
2 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsUnsubscriptionsUserUnsubscriptionItems
object
3 properties
2 required
Contacts_getFolders_Response_200
object
2 properties
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaTransacAttributesItems
object
3 properties
3 required
CreateAttributeRequestBadRequestError
object
2 properties
2 required
PostContactInfoContacts
object
4 properties
GetAttributesRequestBadRequestError
object
2 properties
2 required
RequestContactExportRequestBadRequestError
object
2 properties
2 required
RemoveContactFromListRequestBadRequestError
object
2 properties
2 required
ContactsIdentifierGetParametersIdentifier
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaUnsubscriptions
object
2 properties
2 required
Contacts_getFolderLists_Response_200
object
2 properties
ContactsExportPostRequestBodyContentApplicationJsonSchemaCustomContactFilterActionForEmailCampaigns
string
Mandatory if neither actionForContacts nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on email camp…
ContactsFoldersFolderIdGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaMessagesSentItems
object
2 properties
2 required
CreateDoiContactRequestBadRequestError
object
2 properties
2 required
AddContactToListRequestBadRequestError
object
2 properties
2 required
Contacts_getList_Response_200
object
9 properties
7 required
errorModel
object
2 properties
1 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaAttributes
object
Set of attributes of the contact
ContactsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsExportPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsAttributesGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetContactDetailsAttributes
object
Set of attributes of the contact
ContactsListsListIdGetResponsesContentApplicationJsonSchemaCampaignStatsItems
object
2 properties
2 required
ContactsSegmentsGetParametersSort
string
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsHardBouncesItems
object
2 properties
2 required
Contacts_requestContactExport_Response_202
object
1 property
1 required
GetFolderRequestBadRequestError
object
2 properties
2 required
GetContactInfoRequestBadRequestError
object
2 properties
2 required
ContactsListsListIdContactsAddPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsAttributesAttributeCategoryAttributeNamePutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsAttributesGetResponsesContentApplicationJsonSchemaAttributesItemsCategory
string
Category of the attribute
UpdateAttributeRequestBadRequestError
object
2 properties
2 required
Contacts_createAttribute_Response_201
object
Empty response body
ContactsListsPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
getCampaignStats
object
18 properties
13 required
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaUnsubscriptionsUserUnsubscriptionItems
object
3 properties
2 required
contactErrorModel
object
3 properties
2 required
ContactsSegmentsGetResponsesContentApplicationJsonSchemaSegmentsItems
object
4 properties
3 required
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaComplaintsItems
object
2 properties
2 required
DeleteMultiAttributeOptionsRequestNotFoundError
object
2 properties
2 required
Contacts_getContactStats_Response_200
object
Campaign Statistics for the contact
9 properties
ContactsIdentifierPutRequestBodyContentApplicationJsonSchemaAttributes
ContactsImportPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsListsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
Contacts_createContact_Response_201
object
1 property
ContactsPostRequestBodyContentApplicationJsonSchemaAttributes
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaClickedItemsLinksItems
object
4 properties
4 required
GetListsRequestBadRequestError
object
2 properties
2 required
ContactsDoubleOptinConfirmationPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteMultiAttributeOptionsRequestBadRequestError
object
2 properties
2 required
ImportContactsRequestBadRequestError
object
2 properties
2 required
GetSegmentsRequestBadRequestError
object
2 properties
2 required
Contacts_importContacts_Response_202
object
1 property
1 required
ContactsListsListIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsImportPostRequestBodyContentApplicationJsonSchemaNewList
object
To create a new list and import the contacts into it, pass the listName and an optional folderId.
2 properties
ContactsFoldersFolderIdPutResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
DeleteAttributeRequestNotFoundError
object
2 properties
2 required
ContactsAttributesAttributeCategoryAttributeNamePostRequestBodyContentApplicationJsonSchemaEnumerationItems
object
2 properties
2 required
getFolder
object
5 properties
5 required
Contacts_getSegments_Response_200
object
2 properties
CreateFolderRequestBadRequestError
object
2 properties
2 required
ContactsAttributesAttributeCategoryAttributeNamePutParametersAttributeCategory
string
GetFolderListsRequestBadRequestError
object
2 properties
2 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsUnsubscriptionsAdminUnsubscriptionItems
object
2 properties
1 required
UpdateFolderRequestBadRequestError
object
2 properties
2 required
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaClickedItems
object
2 properties
2 required
ContactsFoldersFolderIdListsGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
GetFoldersRequestBadRequestError
object
2 properties
2 required
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaDeliveredItems
object
2 properties
2 required
ContactsIdentifierPutParametersIdentifierType
string
ContactsAttributesAttributeCategoryAttributeNamePostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsListsListIdContactsRemovePostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
PostContactInfoContactsFailure
ContactsAttributesAttributeTypeMultipleChoiceAttributeMultipleChoiceAttributeOptionDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ConsentGroupItemStatus
string
The contact's subscription status within this consent group
Contacts_addContactToList_Request
ContactsDoubleOptinConfirmationPostRequestBodyContentApplicationJsonSchemaAttributes
ContactsAttributesAttributeCategoryAttributeNamePostParametersAttributeCategory
string
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaUnsubscriptionsAdminUnsubscriptionItems
object
2 properties
1 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsOpenedItems
object
4 properties
4 required
PostContactInfoContactsSuccess
ContactsExportPostRequestBodyContentApplicationJsonSchemaCustomContactFilterActionForContacts
string
Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns is passed. This will export the contacts on the basis of provided action applied on cont…
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsComplaintsItems
object
2 properties
2 required
ContactErrorModelMetadata
object
Additional information about the error
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaHardBouncesItems
object
2 properties
2 required
ContactsFoldersPostResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsFoldersFolderIdListsGetParametersSort
string
ContactsIdentifierDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsFoldersFolderIdDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsDeliveredItems
object
2 properties
2 required
ContactsAttributesAttributeCategoryAttributeNameDeleteResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsAttributesAttributeTypeMultipleChoiceAttributeMultipleChoiceAttributeOptionDeleteParametersAttributeType
string
DeleteListRequestBadRequestError
object
2 properties
2 required
ContactsAttributesGetResponsesContentApplicationJsonSchemaAttributesItems
object
6 properties
2 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsTransacAttributesItems
object
ContactsAttributesAttributeCategoryAttributeNamePutRequestBodyContentApplicationJsonSchemaEnumerationItems
object
2 properties
2 required
ContactsImportPostRequestBodyContentApplicationJsonSchemaJsonBodyItems
object
2 properties
ContactsIdentifierGetParametersIdentifierType
string
ContactsFoldersGetResponsesContentApplicationJsonSchemaCode
string
Error code displayed in case of a failure
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatistics
object
Campaign statistics of the contact
9 properties
DeleteContactRequestBadRequestError
object
2 properties
2 required
Contacts_getAttributes_Response_200
object
1 property
1 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsClickedItemsLinksItems
object
4 properties
4 required
ContactsAttributesGetResponsesContentApplicationJsonSchemaAttributesItemsEnumerationItems
object
3 properties
3 required
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsUnsubscriptions
object
Listing of the unsubscription for the contact
2 properties
2 required
Contacts_createDoiContact_Response_201
object
Empty response body
ContactsIdentifierGetResponsesContentApplicationJsonSchemaStatisticsSoftBouncesItems
object
2 properties
2 required
DeleteAttributeRequestBadRequestError
object
2 properties
2 required
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaSoftBouncesItems
object
2 properties
2 required
ContactErrorModelCode
string
Error code displayed in case of a failure
ContactsIdentifierCampaignStatsGetResponsesContentApplicationJsonSchemaOpenedItems
object
4 properties
4 required
Contacts_createFolder_Response_201
object
1 property
1 required
ContactsExportPostRequestBodyContentApplicationJsonSchemaCustomContactFilterActionForSmsCampaigns
string
Mandatory if neither actionForContacts nor actionForEmailCampaigns is passed. This will export the contacts on the basis of provided action applied on sms camp…
ContactsAttributesGetResponsesContentApplicationJsonSchemaAttributesItemsType
string
Type of the attribute
Contact
object
8 properties
ContactList
object
2 properties
CreateContact
object
5 properties
ErrorResponse
object
2 properties
UpdateContact
object
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Brevo 12
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 Email Activity API
brevo Email Campaigns API
brevo Email Templates API
brevo Folders API
brevo Import API
brevo Messages API
#Contacts
Where this information came from
This is an independent, third-party profile of brevo Contacts 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.