---
title: "List Linked Clients"
method: GET
path: "/linkedClient"
---

# List Linked Clients

`GET /linkedClient`

Get a list of all Linked Clients filtered by various params.

## Query parameters

- `createdDateFrom` string
- `createdDateTo` string
- `name` string
- `email` string
- `contacts` string
- `status` string
- `type` string
- `page` integer
- `size` integer
- `sort` string
- `offset` integer

## Response `200`

200

- object
  - `content` object[]
    - `id` integer
    - `accountHolderId` string
    - `createdDateTime` string
    - `status` string
    - `kycStatus` string
    - `friendlyName` string
    - `metadata` object
      - `userId` string
    - `clientType` string
    - `individual` object
      - `address` object
        - `addressLine1` string
        - `addressLine2` string
        - `city` string
        - `country` string
        - `postCode` string
        - `state` string
      - `firstName` string
      - `middleName` string
      - `lastName` string
      - `dateOfBirth` string
      - `email` string
      - `phone` string
      - `identificationType` string
      - `identificationValue` string
  - `pageable` object
    - `sort` object
      - `sorted` boolean
      - `unsorted` boolean
      - `empty` boolean
    - `pageSize` integer
    - `pageNumber` integer
    - `offset` integer
    - `paged` boolean
    - `unpaged` boolean
  - `totalPages` integer
  - `last` boolean
  - `totalElements` integer
  - `first` boolean
  - `sort` object
    - `sorted` boolean
    - `unsorted` boolean
    - `empty` boolean
  - `numberOfElements` integer
  - `size` integer
  - `number` integer
  - `empty` boolean

## Other responses

- `400` — 400

---

[API](https://skmtc.net/openpayd/apis/openpayd-authorization.md) · [All operations](https://skmtc.net/openpayd/apis/openpayd-authorization/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpayd/openpayd-authorization/versions/354ac572abda/schema)