---
title: "Get information about all related customers"
method: GET
path: "/customers/{customer_id}/related-customers"
tags: ["Customers"]
---

# Get information about all related customers

`GET /customers/{customer_id}/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](https://carecloud.readme.io/reference/getcustomerrelationtypes)

## Path parameters

- `customer_id` string, required

## Query parameters

- `count` integer
- `offset` integer
- `sort_field` string
- `sort_direction` 'ASC' | 'DESC'
- `related_customer_id` string
- `customer_relation_type_id` string
- `all_customer_relations` true | false

## Headers

- `Accept-Language` string

## Response `200`

OK

- object
  - `data` object
    - `related_customers` RelatedCustomer[] — Collection of all related customers.
      - `customer_relation_id` string — The unique ID of the customer relation.
      - `related_customer_id` string, required — The unique ID of the related customer. [GET /customers](https://carecloud.readme.io/reference/getcustomers)
      - `short_name` string — Short name of the customer.
      - `customer_relation_type_id` string, required — The unique ID of the customer relation type. [GET /customer-relation-types](https://carecloud.readme.io/reference/getcustomerrelationtypes)
      - `is_leading` boolean, required — Parameter says, if related customer is a leader in their relationship. *Example: Parent is a leader, child is a follower*
      - `valid_from` string — Date and time when customer relation starts. *(YYYY-MM-DD HH:MM:SS)*
      - `valid_to` string — Date and time when customer relation ends. *(YYYY-MM-DD HH:MM:SS)*
      - `last_change` string — Date and time of the last change. *(YYYY-MM-DD HH:MM:SS)*
      - `state` 0 | 1 | 2 — State of the related customer. *Possible values are: 0 - deleted / 1 - active / 2 - non active*
    - `total_items` integer — The number of all found related customers.

## Other responses

- `400` — Bad input parameter. The response body's `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.
- `401` — The client has invalid credentials or auth token.
- `403` — The client does not exist or the client tried to access an unauthorized property or resource.
- `404` — The resource was not found.
- `405` — The resource does not support the specified HTTP method.
- `429` — Too many requests - more than the resource limit.
- `500` — Server is not working as expected.
- `503` — Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

---

[API](https://skmtc.net/crmcarecloud/apis/rest-api-reference.md) · [All operations](https://skmtc.net/crmcarecloud/apis/rest-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crmcarecloud/rest-api-reference/revisions/329c06dbf8d9/schema)