Sign in

v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customers

Get all customer cards

Get information about all customer cards.

Cards are the primary loyalty identifiers for customers. A customer can hold multiple cards (physical or virtual), each with a card number, card type, and validity period. Cards are used to identify the customer at a point of sale and to accumulate loyalty points and credits.

Related: GET /cards

get/customers/{customer_id}/cards

Path parameters

customer_idstring required

The unique ID of the customer.

Query parameters

countinteger

The number of records to return in API response.

⚠️ We recommended adjust the batch size based on processing time. Depending on the response time of the request. Default value of 100 records is used if count parameter is not set.

offsetinteger

The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.

sort_fieldstring

Name of the sorting parameter. You can sort by any of the first level parameters from the resource response. Response is sorted by the specified field.

sort_direction'ASC' | 'DESC'

Direction of sorting the response list.

card_numberstring

Number of the customer card.

card_type_idstring

The unique ID of the card type. GET /card-types

is_validtrue | false

in validity range - true / before or after validity range - false / no value - all

card_number_liststring[]

List of the card numbers. If used, a list of cards will be returned if matching card numbers in CareCloud. In case you want to filter multiple options use array syntax : card_number_list[]=1000000000016&card_number_list[]=2000000000025 Logic OR is used between values.

Headers

Accept-Languagestring

The unique ID of the language code by ISO 639-1.

Response

OK

Example response

{
  "data": {
    "cards": [
      {
        "card_id": "81eaeea13b8984a169c490a325",
        "customer_id": "8ea2591121e636086a4a9c0992",
        "card_type_id": "8bed991c68a470e7aaeffbf048",
        "card_number": "1000000000016",
        "secondary_card_number": "AXNFUAIOHFDSNKA",
        "valid_from": "2021-04-14 00:00:00",
        "valid_to": "2059-07-05 00:00:00",
        "last_change": "2019-07-15 17:26:34",
        "state": 1
      }
    ],
    "total_items": 1
  }
}