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