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

{
  "success": true,
  "client": {
    "clientId": "DEF",
    "clientName": "Client DEF Corp",
    "description": "New Alpha client",
    "dbId": "D2026A00003",
    "modelId": "SM2026A00004",
    "vdmId": "V2026A00109",
    "facadeId": null,
    "experimentIds": [],
    "coreModelId": "SM2026A00001",
    "status": "ACTIVE",
    "onboardedBy": "admin_user_id",
    "onboardedDate": "2026-03-17T10:00:00.000Z",
    "lastModifiedDate": "2026-03-17T10:00:00.000Z",
    "isActive": true,
    "isDeleted": false
  }
}

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.

​
Path Parameters

​
clientId
string
required
The client identifier (e.g., "DEF").

​
Response

​
success
boolean
Whether the request completed.
​
client
object
The client registry record with all resource IDs.
curl "https://<your-instance>/v1/bi/admin/clients/DEF/<userToken>" \
  -H "CTN: <csrf-token>" \
  --cookie "LASID=<session>;ATN=<access>;RTN=<refresh>"

{
  "success": true,
  "client": {
    "clientId": "DEF",
    "clientName": "Client DEF Corp",
    "description": "New Alpha client",
    "dbId": "D2026A00003",
    "modelId": "SM2026A00004",
    "vdmId": "V2026A00109",
    "facadeId": null,
    "experimentIds": [],
    "coreModelId": "SM2026A00001",
    "status": "ACTIVE",
    "onboardedBy": "admin_user_id",
    "onboardedDate": "2026-03-17T10:00:00.000Z",
    "lastModifiedDate": "2026-03-17T10:00:00.000Z",
    "isActive": true,
    "isDeleted": false
  }
}