CRcrmcarecloud
Customers

Get information about a customer

Get information about a specific customer account.

Returns the full customer record including personal and contact details, address, consent status, source and partner assignments. The customer is the central entity of the CareCloud CRM and aggregates data from all connected applications and platforms.

Use the customer_short_salutation parameter to include a formatted salutation field in the response. Sub-resources such as purchases, cards, credits, and vouchers are available via dedicated sub-resource endpoints under /customers/{customer_id}/.

Related: PUT /customers/{customer_id}, GET /customers

get/customers/{customer_id}

Request

Path parameters

customer_idstring required

The unique ID of the customer.

Query parameters

customer_short_salutationboolean

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-Languagestring

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

Response

OK

Example response

{
  "data": {
    "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
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.