Get information about all related customers
Get a list of customers' relations in the CareCloud platform.
Related customers are customer accounts linked to each other by a defined relationship type - for example, household members, referral relationships, or account groupings. This endpoint returns all relation records for the specified customer.
Related: GET /customer-relation-types
Path parameters
The unique ID of the customer.
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.
The unique ID of the related customer. GET /customers
The unique ID of the customer relation type in CareCloud.
The API call returns all relations (currently valid and relations from the past) in case of true value. If the parameter is not set or has value false, only currently valid relations are returned.
Headers
The unique ID of the language code by ISO 639-1.
Response
OK
Example response
{
"data": {
"related_customers": [
{
"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
}
],
"total_items": 1
}
}