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
}
}
{
"success": false,
"error": "Client DEF not found"
}
BI Administration API
Get Client
Get a single onboarded client’s details including all resource IDs
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
}
}
{
"success": false,
"error": "Client DEF not found"
}
Path Parameters
string
required
The client identifier (e.g.,
"DEF").Response
boolean
Whether the request completed.
object
The client registry record with all resource IDs.
Show client properties
Show client properties
string
Client ID
string
Client display name
string
Client description
string
Snowflake connection ID
string
Client semantic model ID
string
Virtual Data Mart ID
string
Dashboard facade ID
array
Experiment IDs
string
Parent core model ID
string
ACTIVE, FAILED, or DELETEDstring
User who performed onboarding
string
ISO timestamp
string
Last modification timestamp
boolean
Whether the client is active
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
}
}
{
"success": false,
"error": "Client DEF not found"
}