Export a customer

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Use this endpoint to retrieve all data stored for a specific customer. It returns all customer attributes and events, along with their properties, for a single customer.

📘

Note

When interpreting dynamic filenames, the scheduled export run time matters, not the actual time of the export run.

Authorization

This endpoint requires the following access type and permissions:

Available access typePermissions needed
Private accessGDPR > Export customer

For more details, see:

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. See the Authentication section for details.Required
content-typestringapplication/jsonRequired
📘

Note

For use cases that require date filtering, the Data Exports feature may be a better fit. Note that Data Exports is a paid feature.

Path Params
string
required
Defaults to 12345678-1234-1234-1234-123456789abc
Body Params
customer_ids
object
required
Headers
string
required
Defaults to Basic <KeyID/Secret>
Response

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

© Bloomreach, Inc. All rights reserved.