Skip to main content
POST
cURL
Start a bulk export of your customers. The export runs in the background: poll Get Export until its status is completed, then fetch the file from download_url. The filters are the ones List Customers takes, and each line of the file is one customer in the shape that endpoint returns. An empty body exports every customer. A program may have one export pending or processing at a time. A second request returns 409 naming the export already running. See the customer exports guide for the full flow.

Authorizations

Authorization
string
header
required

An API key linked to a Program in LoyaltyLion, with a set of permissions (scopes). API keys can be created manually, or acquired through an OAuth2 flow. The API key should be provided as a Bearer token in the Authorization header

Body

application/json

Body

email
string

Return only customers whose email contains the specified string

created_at_min
string

Return only customers created on or after the specified ISO 8601 datetime string

created_at_max
string

Return only customers created before the specified ISO 8601 datetime string

updated_at_min
string

Return only customers updated on or after the specified ISO 8601 datetime string

updated_at_max
string

Return only customers updated before the specified ISO 8601 datetime string

Response

202

export
Pending customer export · object
required

An export moves from pending to processing to completed, and to expired once its file is deleted seven days later; a run that cannot finish ends failed. Which fields are present depends on its status