> ## 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.

# Get Client

> Get a single onboarded client's details including all resource IDs

## Path Parameters

<ParamField path="clientId" type="string" required>
  The client identifier (e.g., `"DEF"`).
</ParamField>

## Response

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

<ResponseField name="client" type="object">
  The client registry record with all resource IDs.

  <Expandable title="client properties">
    <ResponseField name="clientId" type="string">Client ID</ResponseField>
    <ResponseField name="clientName" type="string">Client display name</ResponseField>
    <ResponseField name="description" type="string">Client description</ResponseField>
    <ResponseField name="dbId" type="string">Snowflake connection ID</ResponseField>
    <ResponseField name="modelId" type="string">Client semantic model ID</ResponseField>
    <ResponseField name="vdmId" type="string">Virtual Data Mart ID</ResponseField>
    <ResponseField name="facadeId" type="string">Dashboard facade ID</ResponseField>
    <ResponseField name="experimentIds" type="array">Experiment IDs</ResponseField>
    <ResponseField name="coreModelId" type="string">Parent core model ID</ResponseField>
    <ResponseField name="status" type="string">`ACTIVE`, `FAILED`, or `DELETED`</ResponseField>
    <ResponseField name="onboardedBy" type="string">User who performed onboarding</ResponseField>
    <ResponseField name="onboardedDate" type="string">ISO timestamp</ResponseField>
    <ResponseField name="lastModifiedDate" type="string">Last modification timestamp</ResponseField>
    <ResponseField name="isActive" type="boolean">Whether the client is active</ResponseField>
  </Expandable>
</ResponseField>

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

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "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
    }
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "success": false,
    "error": "Client DEF not found"
  }
  ```
</ResponseExample>