---
title: "GET /private/get_broker_clients"
method: GET
path: "/private/get_broker_clients"
tags: ["Block Trade", "Private"]
---

# GET /private/get_broker_clients

`GET /private/get_broker_clients`

**Broker Method** Returns a list of clients registered under the broker account. Each client record includes:

- `client_id` — a numeric identifier that groups one or more linked users under a single client name. Use this value in other Broker Voice API calls (e.g. `private/execute_broker_trade`) to identify the client group.
- `links` — an array of individual user connections belonging to that client. Each link contains a `client_link_id` that uniquely identifies a single user within the client group.

**How to obtain `client_id` and `client_link_id`**

Call this endpoint without parameters to retrieve all clients. Locate the client by name or company, read `client_id` from the top-level object, and read `client_link_id` from the relevant entry in the `links` array. Use these two values together in subsequent Broker Voice API calls to specify which user within a client should be the counterparty.

A link `state` of `connected` means the user has accepted the broker invitation and is ready to trade. Links in `pending` state have not yet been accepted; links in `rejected` state are inactive.

Optionally filter by a specific `client_id` to return only that client's record, or set `include_subaccounts` to `true` to include clients managed by broker sub-accounts.

**Scope:** `block_trade:read`

[Try in API console](https://test.deribit.com/api_console?method=%2Fprivate%2Fget_broker_clients)

## Query parameters

- `client_id` integer
- `include_subaccounts` boolean

## Response `200`

Success response

- PrivateGetBrokerClientsResponse
  - `jsonrpc` '2.0', required — The JSON-RPC version (2.0)
  - `id` integer — The id that was sent in the request
  - `result` object[], required
    - `client_id` integer, required — Numeric identifier for the client group. Used in Broker Voice API calls to reference this client.
    - `client_name` string, required — Name of the client.
    - `company_name` string, required — Company name of the client.
    - `broker_code` string, required — Broker-assigned code used in invitation links for this client.
    - `main_user_id` string — Obscured user ID of the main account linked to this client, if any.
    - `broker_sub_user_id` integer — ID of the broker sub-account that manages this client, if applicable.
    - `lei` string — Legal Entity Identifier (LEI) of the client, if provided.
    - `brn` string — Business Registration Number (BRN) of the client, if provided.
    - `links` object[], required — Array of individual user connections belonging to this client.
      - `client_link_id` integer, required — Numeric identifier for an individual user within the client group. Used together with `client_id` in Broker Voice API calls.
      - `user_id` string, required — Obscured user ID of the linked user.
      - `name` string, required — Display name for this link.
      - `note` string — Optional note attached to this link.
      - `state` 'connected' | 'pending' | 'rejected', required — Connection state of the link: `connected` (user accepted the invitation and is active), `pending` (invitation sent, not yet accepted), or `rejected` (link is inactive).
      - `confirmations_required` integer, required — Number of broker confirmations required for block trades involving this link.
      - `broker_sub_user_id` integer — ID of the broker sub-account managing this link, if applicable.

---

[API](https://skmtc.net/deribit/apis/deribit-api-2.md) · [All operations](https://skmtc.net/deribit/apis/deribit-api-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/deribit/deribit-api-2/revisions/8dfbbe9fdddf/schema)