---
title: "Get clients"
url: https://docs.truemarkets.co/api/institutional/get-clients-cefi
description: "Query for a user's information."
---

Docs index: https://docs.truemarkets.co/llms.txt

# Get clients

Query for a user's information.

## Request

```
GET https://api.truex.co/v1/cefi/clients
```

### Authentication

Bearer token in `Authorization`

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `x-truex-auth-timestamp` | header | string | yes | Timestamp when request was made in seconds since epoch. Must be no older than 15 seconds and no more than 1 second in the future. It guards against replayed requests. |
| `id` | query | string | no | ID of client to query for. |
| `mnemonic` | query | string | no | Filters clients by mnemonic (human readable text). Returns clients where the mnemonic is an exact match or contains the provided substring. Matching is case-sensitive. |

## Responses

Every error status returns the same body, described in [Errors](https://docs.truemarkets.co/developer-resources/errors.md).

### 200

Successful operation.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `[].id` | string | no |  |
| `[].status` | string, one of `INITIALIZED`, `ACTIVE`, `DISABLED` | no | Current client state. |
| `[].info` | object | no |  |
| `[].info.organization_id` | string (uuid) | no | Must be UUIDv4. [RFC 9562](https://datatracker.ietf.org/doc/html/rfc9562#name-uuid-version-4). |
| `[].info.mnemonic` | string | no | Client supplied human readable name of the client entity. |
| `[].info.type` | string, one of `INSTITUTION`, `INDIVIDUAL`, `APPLICATION` | no | Client designation. |
| `[].info.maker_fee_tier` | integer | no | Client's current maker fee tier. |
| `[].info.taker_fee_tier` | integer | no | Client's current taker fee tier. |
| `[].info.self_trade_prevention` | string, one of `INVALID`, `NONE`, `CANCEL_AGGRESSIVE`, `CANCEL_BOTH` | no | Client level self trade protection instruction. * **INVALID** Client level self trade protections are in an invalid state and may result in order rejection. * **NONE** No self trade protections are enabled for this client. Can be overridden at the order level. * **CANCEL_AGGRESSIVE** All orders entered with this client ID will have cancel aggressive self trade protections enabled. * **CANCEL_BOTH** All order entered with this client ID will have cancel both self trade protections enabled. |
| `[].controls` | object | no | Set by the exchange; read-only to clients. |
| `[].controls.rate_limit_tier` | integer | no | The client's request rate-limit tier; 0 is the default. |
| `[].controls.instrument_entitlements` | array of string, one of `SPOT`, `OUTCOME` | no | Instrument entitlements the client holds. |
| `[].controls.flags` | integer | no | Reserved client flags. |

### 400

Bad request.

### 401

Unauthorized.

### 403

Forbidden.

### 408

Request timeout.

### 415

Unsupported media type.

### 500

Internal server error.

### 503

Service unavailable.
