Loyalty Admin API

ExportCustomerData1

Exports all the data Bubblehouse has on a given customer.

This is meant to handle GDPR data export requests.

MethodGET or POST
KindRead-Only
URLhttps://app.bubblehouse.com/api/v2023061/<shop>/ExportCustomerData1
AuthenticationShop TokenAdmin Customer Token

Input

  • customerCustomerIdentity1required if using a shop token

    A customer to operate upon, when using a shop token.

    If you're using a customer token and decide to pass this field (which we do not recommend), it must match the customer from the token.

Output

Customer data in JSON format. The exact structure of this data is subject to change.

This is only meant to serve data takeout requests, not for building any automations via the API. You should put the data in a .json file in your data takeout archive, or allow the customer to download it directly.

You probably don't even want to parse the response as JSON, and just treat it as raw text.

Note that this call is relatively expensive. We serve it in real time without queuing, but we reserve the right to impose heavy rate limits on this call if we notice a client abusing it for something other than the intended purpose (which wouldn't be wise anyway, given that the structure of the data returned could change without notice).

Specific Errors

StatusErrorReason & Examples

None.

API-wide Errors

StatusErrorReason & Examples

None.

Global Errors

StatusErrorReason & Examples
401invalid_token

The provided authentication token is invalid or has expired.

{"id":"invalid_token","message":"The token has expired"}
429rate_limit_exceeded

Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase.

{"id":"rate_limit_exceeded","message":"You are over the read limit per second for this customer"}
400obsolete_global_api_version

The global API version you are trying to use is no longer supported.

{"id":"obsolete_global_api_version"}
400invalid_global_api_version

The global API version you are trying to use has never existed.

{"id":"invalid_global_api_version"}
400inaccessible_global_api_version

The global API version you are trying to use is not enabled on your account.

{"id":"inaccessible_global_api_version"}
Previous
AdjustCustomerState3