Get all 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)
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 by email.
Phone number of the customer with international prefix (420000000000).
The unique ID of the customer source. It identifies the system where the customer belongs or the customer account was created. GET /customer-sources
Search by first name.
Search by last name.
Customer's date of birth. Accepts the format YYYY-MM-DD or DD.MM.YYYY.
List of the email addresses of the customers. In case you want to filter multiple options use array syntax : email_list[]=happy_customer@crmcarecloud.com&email_list[]=another_customer@crmcarecloud.com Logic OR is used between values.
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.
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
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"customers": [
{
"customer_id": "8ea2591121e636086a4a9c0992",
"personal_information": {
"salutation": "Dear Mr. Smith",
"gender": 1,
"first_name": "John",
"last_name": "Smith",
"pre_nominals": "Dr.",
"post_nominals": "Ph.D",
"birthdate": "1985-02-12",
"email": "happy_customer@crmcarecloud.com",
"phone": "420523828931",
"language_id": "en",
"store_id": "8bed991c68a4",
"photo_url": "https://example.com/photos/customer.jpg",
"address": {
"address1": "Old Town Square",
"address2": "34",
"address3": "1a",
"zip": "11000",
"city": "Prague 1",
"country_code": "cz"
},
"agreement": {
"agreement_gtc": 1,
"agreement_profiling": 1,
"agreement_marketing_communication": 1,
"custom_agreements": [
{
"agreement_id": "8fd73167342d06899c4c015320",
"agreement_value": 2
}
]
},
"consents": [
{
"consent_id": "8fd73167342d06899c4c015320",
"consent_value": 2,
"last_change": "2024-06-23 11:47:23"
}
]
},
"doi_email": "2019-06-23 11:47:22",
"doi_phone": "2019-06-23 11:47:23",
"last_change": "2019-06-23 11:47:23",
"state": 1
}
],
"total_items": 1
}
}