TAtalon
Loyalty cards

Export loyalty cards

[!note] Management API endpoints are not meant to be used in real-time integrations that directly serve your end users. Rate limit: 3 requests per second.

Download a CSV file containing the loyalty cards from a specified loyalty program.

[!tip] If the exported CSV file is too large to view, you can split it into multiple files.

The CSV file contains the following columns:

  • identifier: The unique identifier of the loyalty card.
  • created: The date and time the loyalty card was created.
  • status: The status of the loyalty card.
  • userpercardlimit: The maximum number of customer profiles that can be linked to the card.
  • customerprofileids: Integration IDs of the customer profiles linked to the card.
  • blockreason: The reason for transferring and blocking the loyalty card.
  • generated: An indicator of whether the loyalty card was generated.
  • batchid: The ID of the batch the loyalty card is in.
  • attributes: The custom attributes of this loyalty card.
get/v1/loyalty_programs/{loyaltyProgramId}/cards/export

Request

Path parameters

loyaltyProgramIdinteger required

Identifier of the card-based loyalty program containing the loyalty card. You can get the ID with the List loyalty programs endpoint.

Query parameters

batchIdstring

Filter results by loyalty card batch ID.

createdBeforestring date-time

Only return loyalty cards created before this timestamp.

Note: This must be an RFC3339 timestamp string.

createdAfterstring date-time

Only return loyalty cards created after this timestamp.

Note: This must be an RFC3339 timestamp string.

dateFormat'excel' | 'ISO8601'

Determines the format of dates in the export document.

Response

OK

Changes

No recorded changes to this operation across all 2 revisions of this API.