TAtalon
Loyalty cards

List loyalty cards

Changed on

[!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.

For the given card-based loyalty program, list the loyalty cards that match your filter criteria.

get/v1/loyalty_programs/{loyaltyProgramId}/cards

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

pageSizeinteger

The number of items in the response.

skipinteger

The number of items to skip when paging through large result sets.

sortstring

The field by which results should be sorted. By default, results are sorted in ascending order. To sort them in descending order, prefix the field name with -.

Note: You may not be able to use all fields for sorting. This is due to performance limitations.

identifierstring

The card code by which to filter loyalty cards in the response.

Important: The loyalty card ID requires URL encoding if it contains special characters. For example, you must encode NewCard2026% as NewCard2026%25.

profileIdinteger

Filter results by customer profile ID.

batchIdstring

Filter results by loyalty card batch ID.

Response

OK

hasMoreboolean required

Example response

{
  "hasMore": true,
  "data": [
    {
      "id": 6,
      "created": "2020-06-10T09:05:27.993483Z",
      "programID": 125,
      "programName": "Loyalty_program",
      "programTitle": "Loyalty program",
      "status": "active",
      "blockReason": "Current card lost. Customer needs a new card.",
      "attributes": {
        "PIN": 1234,
        "Language": "DE"
      },
      "identifier": "summer-loyalty-card-0543",
      "usersPerCardLimit": 111,
      "profiles": [
        {
          "integrationId": "R195412",
          "timestamp": "2021-09-12T10:12:42Z"
        }
      ],
      "ledger": {
        "currentBalance": 100,
        "pendingBalance": 10,
        "negativeBalance": 10,
        "tentativeCurrentBalance": 100,
        "tentativePendingBalance": 20,
        "tentativeNegativeBalance": 100,
        "currentTier": {
          "id": 11,
          "name": "bronze",
          "startDate": "2025-05-03T12:32:00Z07:00",
          "expiryDate": "2026-08-02T15:04:05+07:00",
          "downgradePolicy": "one_down",
          "source": "points",
          "reason": "Subscription to newsletter"
        },
        "pointsToNextTier": 20,
        "nextTierName": "Silver"
      },
      "modified": "2021-09-12T10:12:42Z",
      "oldCardIdentifier": "summer-loyalty-card-0543",
      "newCardIdentifier": "summer-loyalty-card-0543",
      "batchId": "wdefpov"
    }
  ]
}

Changes

  • 7ef1b9504c3aRevision changes
    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property /////// to the response with the status