API Reference

Get information about a customer

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

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

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique ID of the customer.

Query Params
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
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