---
title: "List customer relationships"
method: GET
path: "/v2/customers/{id}/relationships"
tags: ["Customers.Relationships"]
---

# List customer relationships

`GET /v2/customers/{id}/relationships`

## Request

- Base URL: `https://api.carecycle.ai`
- URL: `https://api.carecycle.ai/v2/customers/{id}/relationships`
- Auth: API key in header `x-api-key`

List the customers linked to this customer, with whether each shares this customer's phone number and which one is the number's primary.

## Path parameters

- `id` string, uuid, required: Customer ID

## Response `200`

GET /v2/customers/:id/relationships Positive response

- GetV2CustomersIdRelationshipsPositiveResponse
  - `relationships` object[], required
    - `id` string, uuid, required
    - `customerId` string, uuid, required: The customer the link was added from
    - `relatedCustomerId` string, uuid, required: The customer who is the other customer's relationshipType
    - `relationshipType` 'spouse' | 'child' | 'parent' | 'sibling' | 'power_of_attorney' | 'other', required: What the related customer is to the customer in the path, for example spouse or child
    - `createdAt` string, date-time, required: Relationship creation time. ISO 8601 timestamp
    - `updatedAt` string, date-time, required: Relationship last update time. ISO 8601 timestamp
    - `direction` 'outgoing' | 'incoming', required: outgoing: the listed customer is this customer's relationshipType. incoming: this customer is the listed customer's relationshipType.
    - `customer` object, required
      - `id` string, uuid, required
      - `firstName` string, nullable, required
      - `lastName` string, nullable, required
      - `dateOfBirth` string, date, nullable, required: Customer date of birth. Canonical format: YYYY-MM-DD
      - `callerId` string, nullable, required
      - `isPhonePrimary` boolean, required
      - `sharesPhone` boolean, required: Whether they share this customer's phone number

## Other responses

- `400`: GET /v2/customers/:id/relationships Negative response 400
- `401`: GET /v2/customers/:id/relationships Negative response 401
- `403`: GET /v2/customers/:id/relationships Negative response 403
- `404`: GET /v2/customers/:id/relationships Negative response 404
- `409`: GET /v2/customers/:id/relationships Negative response 409
- `422`: GET /v2/customers/:id/relationships Negative response 422
- `429`: GET /v2/customers/:id/relationships Negative response 429
- `500`: GET /v2/customers/:id/relationships Negative response 500
- `502`: GET /v2/customers/:id/relationships Negative response 502
- `503`: GET /v2/customers/:id/relationships Negative response 503

---

[API](https://skmtc.dev/carecycle/apis/carecycle-public-api.md) - [All operations](https://skmtc.dev/carecycle/apis/carecycle-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/carecycle/apis/carecycle-public-api/revisions/db390c743c36?raw)