---
title: "List Related Accounts"
method: GET
path: "/accounts/{account_id}/related"
tags: ["accounts"]
---

# List Related Accounts

`GET /accounts/{account_id}/related`

## Request

- Base URL: `https://dev.whispa.net` (the document declares no server; this is the origin it was published from)
- URL: `https://dev.whispa.net/accounts/{account_id}/related`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

The customer's other accounts, and accounts sharing one of this
account's numbers or its address that may be theirs (admin only).

Same customer means the same provider customer id, or the same name and
date of birth. Removed accounts are included and carry ``removed_at``.
For a person to read before deciding; nothing here changes dialling.

## Path parameters

- `account_id` string, uuid, required

## Response `200`

Successful Response

- RelatedAccountsRead: The other accounts a reviewer should know about before deciding. Each list is bounded; ``*_has_more`` says when more exist than are shown.
  - `same_customer` RelatedAccountRead[]
    - `id` string, uuid, required
    - `external_id` string, required
    - `account_number` string, nullable
    - `display_name` string, required
    - `account_status` string, nullable
    - `account_callable` boolean, nullable
    - `account_synced_at` string, date-time, required
    - `collection_stage` string, nullable
    - `arranged_or_paid` boolean, required
    - `balance` number, nullable
    - `removed_at` string, date-time, nullable
    - `campaign_id` string, uuid, nullable
    - `campaign_name` string, nullable
    - `membership_status` string, nullable
  - `same_customer_has_more` boolean
  - `possible` PossibleAccountMatchRead[]
    - `id` string, uuid, required
    - `external_id` string, required
    - `account_number` string, nullable
    - `display_name` string, required
    - `account_status` string, nullable
    - `account_callable` boolean, nullable
    - `account_synced_at` string, date-time, required
    - `collection_stage` string, nullable
    - `arranged_or_paid` boolean, required
    - `balance` number, nullable
    - `removed_at` string, date-time, nullable
    - `campaign_id` string, uuid, nullable
    - `campaign_name` string, nullable
    - `membership_status` string, nullable
    - `matched_on` string[], required
  - `possible_has_more` boolean

## Other responses

- `422`: Validation Error

---

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