> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tarvah.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Clients

> List all onboarded clients with pagination and search

## Query Parameters

<ParamField query="page" type="number">
  Page number (1-indexed). Defaults to `1`.
</ParamField>

<ParamField query="limit" type="number">
  Results per page. Defaults to `100`.
</ParamField>

<ParamField query="status" type="string">
  Filter by status: `ACTIVE`, `FAILED`, or `DELETED`.
</ParamField>

<ParamField query="search" type="string">
  Search by client ID or name (case-insensitive regex).
</ParamField>

## Response

<ResponseField name="success" type="boolean">
  Whether the request completed.
</ResponseField>

<ResponseField name="data" type="array">
  Array of client registry records.
</ResponseField>

<ResponseField name="pagination" type="object">
  <Expandable title="pagination properties">
    <ResponseField name="page" type="number">Current page</ResponseField>
    <ResponseField name="limit" type="number">Results per page</ResponseField>
    <ResponseField name="total" type="number">Total matching records</ResponseField>
    <ResponseField name="totalPages" type="number">Total pages</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://<your-instance>/v1/bi/admin/clients/<userToken>?status=ACTIVE&limit=10" \
    -H "CTN: <csrf-token>" \
    --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>"
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "success": true,
    "data": [
      {
        "clientId": "ABC",
        "clientName": "Client ABC Corp",
        "dbId": "D2026A00001",
        "modelId": "SM2026A00002",
        "vdmId": "V2026A00101",
        "facadeId": "F2026A00010",
        "experimentIds": ["E2026A00020", "E2026A00021"],
        "coreModelId": "SM2026A00001",
        "status": "ACTIVE",
        "onboardedBy": "admin_user",
        "onboardedDate": "2026-03-01T00:00:00.000Z"
      },
      {
        "clientId": "DEF",
        "clientName": "Client DEF Corp",
        "dbId": "D2026A00003",
        "modelId": "SM2026A00004",
        "vdmId": "V2026A00109",
        "facadeId": null,
        "experimentIds": [],
        "coreModelId": "SM2026A00001",
        "status": "ACTIVE",
        "onboardedBy": "admin_user",
        "onboardedDate": "2026-03-17T10:00:00.000Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 10,
      "total": 2,
      "totalPages": 1
    }
  }
  ```
</ResponseExample>