API Reference

Get all cards

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

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

The unique ID of the customer. GET /customers

string

Number of the customer card.

string

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

integer
enum

State of the card. Possible values are: 0 - blocked / 1 - active

Allowed:
boolean
enum

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

Allowed:
card_number_list
array of strings
length ≤ 1000

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.

card_number_list
boolean
enum

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

Allowed:
Headers
string
Defaults to cs, en-gb;q=0.8

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

Responses

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

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 3 months 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 3 months ago