Get information about all card types
Get a list of all card types configured in the CareCloud platform. Card types define categories of customer cards - for example, a loyalty card, a digital membership card, or a prepaid card - including their name and number prefix. Filter by name or text_id to find a specific card type. 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.
Search record by name or a part of the name.
Filter by one value or a list of card type text IDs. The list of values is available at GET /card-types. In case you want to filter multiple options use array syntax: text_id[]=isic_card&text_id[]=loyalty_card Logic OR is used between values.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"card_types": [
{
"card_type_id": "8bd48117006496e0b1788109b8",
"text_id": "isic_card",
"name": "Postman test type",
"prefix": "092"
}
],
"total_items": 1
}
}