Skip to main content
GET
/
v1
/
bi
/
admin
/
clients
/
{userId}
curl "https://<your-instance>/v1/bi/admin/clients/<userToken>?status=ACTIVE&limit=10" \
  -H "CTN: <csrf-token>" \
  --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>"

{
  "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
  }
}

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.

​
Query Parameters

​
page
number
Page number (1-indexed). Defaults to 1.
​
limit
number
Results per page. Defaults to 100.
​
status
string
Filter by status: ACTIVE, FAILED, or DELETED.
​
search
string
Search by client ID or name (case-insensitive regex).

​
Response

​
success
boolean
Whether the request completed.
​
data
array
Array of client registry records.
​
pagination
object
curl "https://<your-instance>/v1/bi/admin/clients/<userToken>?status=ACTIVE&limit=10" \
  -H "CTN: <csrf-token>" \
  --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>"

{
  "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
  }
}