API Reference

Get information about all card types

get
https://{project_url}/webservice/rest-api/{api_interface}/{version}/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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
≥ 1
Defaults to 100

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.

integer
≥ 0
Defaults to 0

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

string

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.

string
enum

Direction of sorting the response list.

Allowed:
string

Search record by name or a part of the name.

string

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
string
Defaults to cs, en-gb;q=0.8

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

Responses

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 19 days ago

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 19 days ago