Get all customers

get

https://{project_url}/webservice/rest-api/{api_interface}/{version}/customers

Get a list of all customers.

Customers are the central entity of the CareCloud CRM. Each account stores personal and contact details, loyalty program participation (cards, points, credits, vouchers), communication preferences and consent status, segments, custom properties, related customers, addresses, interests, and partner and source assignments.

Supports filtering by email, phone, first name, last name, date of birth, customer source, and a list of customer IDs. Use email_list to retrieve multiple customers by email in a single request.

Related: POST /customers, GET /customers/{customer_id}, GET /customers/actions/search-customers (enterprise interface only)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

count

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.

offset

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.

sort_field

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.

sort_direction

string

enum

Direction of sorting the response list.

Allowed:

string

Search by email.

phone

string

Phone number of the customer with international prefix (420000000000).

customer_source_id

string

The unique ID of the customer source. It identifies the system where the customer belongs or the customer account was created. GET /customer-sources

first_name

string

Search by first name.

last_name

string

Search by last name.

birthdate

string

Customer's date of birth. Accepts the format YYYY-MM-DD or DD.MM.YYYY.

email_list

array of strings

length ≤ 1000

List of the email addresses of the customers.
In case you want to filter multiple options use array syntax : email_list[][email protected]&email_list[][email protected]
Logic OR is used between values.

email_list

customer_ids

array of strings

length ≤ 1000

List of the customer IDs. GET /customers
In case you want to filter multiple options use array syntax : customer_ids[]=8ea2591121e636086a4a9c0992&customer_ids[]=8bed991c68a470e7aaeffbf048
Logic OR is used between values.

customer_ids

customer_short_salutation

boolean

If true, the response will set a short salutation instead of a long one. Short salutations contain the first name of the customer only. If the parameter has a value false or not set, the full salutation is returned in response.

Headers

Accept-Language

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.

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

401The client has invalid credentials or auth token.

403The client does not exist or the client tried to access an unauthorized property or resource.

404The resource was not found.

405The resource does not support the specified HTTP method.

500Server is not working as expected.