v1

latestOpenAPI 3.0.2EULA2026-07-143221521.2 MB
Customers

Detail of a relation between customers

Get information about a specific customer relation.

Returns the detail of a single relationship record between two customer accounts, including the related customer ID and the relation type. To retrieve all relations for a customer, use GET /customers/{customer_id}/related-customers.

get/customers/{customer_id}/related-customers/{customer_relation_id}

Path parameters

customer_idstring required

The unique ID of the customer.

customer_relation_idstring required

The unique ID of relation between two customers in CareCloud.

Headers

Accept-Languagestring

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

Response

OK

Example response

{
  "data": {
    "customer_relation_id": "81eaeea13b8984a169c490a325",
    "related_customer_id": "8aa68a112c62ad5f84a22a0652",
    "short_name": "Peter D.",
    "customer_relation_type_id": "8bed991c68a470e7aaeffbf048",
    "valid_from": "2022-01-09 22:00:00",
    "valid_to": "2022-01-09 22:30:00",
    "last_change": "2022-06-23 11:47:22",
    "state": 1
  }
}