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
The client identifier (e.g.,
"DEF").Response
Whether the request completed.
The client registry record with all resource IDs.
Show client properties
Show client properties
Client ID
Client display name
Client description
Snowflake connection ID
Client semantic model ID
Virtual Data Mart ID
Dashboard facade ID
Experiment IDs
Parent core model ID
ACTIVE, FAILED, or DELETEDUser who performed onboarding
ISO timestamp
Last modification timestamp
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"
}
⌘I