Export a customer

/data/v2/projects/{projectToken}/customers/export-one

Retrieve all data stored for a specific customer.

This method retrieves all customer attributes and events with their properties for a single customer.

Please note that when interpreting the dynamic filenames, scheduled export run matters, not the actual time of export run.

Definition

Authorization

In this API call you must use the following authorization access and permissions:

Available access typePermissions needed
Private accessGDPR > Export customer

Read more about:

Path parameters

ParameterTypeDescriptionRequired
projectTokenstringThe ID of your project.Required

Body parameters

ParameterTypeDescriptionRequired
customer_idsobjectOne or more hard and/or soft customer IDs are required. The most common ones include: registered.At least 1 required.

Headers

ParameterTypeDescriptionRequired
authorizationstringUsed for authentication. Read more in the Authentication section.Required
content-typestringapplication/jsonRequired

📘

For some use cases, it is better to use the Data Exports Bloomreach Engagement feature, since the API does not support date filtering (Note that Exports are a paid feature).

Language
Click Try It! to start a request and see the response here!