Skip to navigation
Contact ManagementContacts

Export contacts

View as Markdown

It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv.

When no contact matches the filter, no export process is created: the endpoint answers 200 with an empty object instead of 202 with a processId. A recurring export should treat that as “nothing to do” rather than as a failure, and must not assume a processId is always present.

Authentication

api-keystring

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

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Request

Values to request a contact export
customContactFilterobjectRequired
Set the filter for the contacts to be exported.
disableNotificationbooleanOptionalDefaults to false

To avoid generating the email notification upon contact export, pass true

exportAttributeslist of stringsOptional

List of all the attributes that you want to export. **These attributes must be present in your contact database. It is required if exportMandatoryAttributes is set false. ** For example: [‘fname’, ‘lname’, ‘email’]

exportMandatoryAttributesbooleanOptionalDefaults to true

To export mandatory attributes like EMAIL, ADDED_TIME, MODIFIED_TIME

exportMetadatalist of stringsOptional

Export metadata of contacts such as _listIds, ADDED_TIME, MODIFIED_TIME.

exportDateInUTCbooleanOptionalDefaults to false
Specifies whether the date fields createdAt, modifiedAt in the exported data should be returned in UTC format.
exportSubscriptionStatuslist of stringsOptional

Export subscription status of contacts for email & sms marketting. Pass email_marketing to obtain the marketing email subscription status & sms_marketing to retrieve the marketing SMS status of the contact.

notifyUrlstringOptionalformat: "url"

Webhook that will be called once the export process is finished. For reference, https://help.brevo.com/hc/en-us/articles/360007666479

Response

process id created
processIdlong
Id of the process created

Errors

400
Bad Request Error
429
Too Many Requests Error