Get all cards
Get a list of all customer cards. Cards are the primary customer identification mechanism in CareCloud. Each card carries a unique number regardless of its format - plastic, electronic, virtual, or membership. A customer can hold multiple cards of different types. Use filters such as customer_id, card_type_id, and card_state to narrow results. See Cards for details.
Query parameters
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.
The number of records from a collection to skip. Default value of 0 is used when parameter offset is not set.
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.
Direction of sorting the response list.
The unique ID of the customer. GET /customers
Number of the customer card.
The unique ID of the card type. GET /card-types
State of the card. Possible values are: 0 - blocked / 1 - active
in validity range - true / before or after validity range - false / no value - all
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.
Include secondary card numbers in search for filters card_number and card_number_list. Possible values: true - CareCloud API search only secondary card numbers / false - CareCloud API search only card numbers / default behavior without parameter - CareCloud API search only card numbers
Headers
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
}
}