> ## Documentation Index
> Fetch the complete documentation index at: https://docs.caret.so/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Workspace

> Get details about the workspace associated with the API key

## Overview

This endpoint returns detailed information about the workspace that the provided API key belongs to. It includes basic metadata like the workspace name, creation date, and settings.

## Authentication

All API requests must authenticate with `Authorization: Bearer <API_KEY>`.

<ParamField header="Authorization" type="string" required>
  Bearer token. Format: `Bearer <API_KEY>`.
</ParamField>

## Response

<ResponseField name="workspace" type="object">
  The workspace object.

  <Expandable title="properties">
    <ResponseField name="id" type="string">
      Unique identifier for the workspace.
    </ResponseField>

    <ResponseField name="name" type="string">
      Name of the workspace.
    </ResponseField>

    <ResponseField name="createdAt" type="string">
      ISO8601 timestamp when the workspace was created.
    </ResponseField>

    <ResponseField name="updatedAt" type="string">
      ISO8601 timestamp when the workspace was last updated.
    </ResponseField>

    <ResponseField name="settings" type="object">
      Workspace settings.

      <Expandable title="properties">
        <ResponseField name="rag_corpus_id" type="string">
          The ID of the RAG corpus associated with the workspace.
        </ResponseField>

        <ResponseField name="company" type="object">
          Company information.

          <Expandable title="properties">
            <ResponseField name="name" type="string">
              Company name.
            </ResponseField>

            <ResponseField name="url" type="string">
              Company website URL.
            </ResponseField>

            <ResponseField name="info" type="string">
              Company description or information.
            </ResponseField>

            <ResponseField name="headcount" type="string">
              Company headcount range.
            </ResponseField>
          </Expandable>
        </ResponseField>

        <ResponseField name="keyterms" type="string[]">
          List of key terms for the workspace.
        </ResponseField>

        <ResponseField name="audio_location" type="string">
          Where audio files are stored. One of: `none`, `local`, `aside-server`,
          `custom-server`.
        </ResponseField>

        <ResponseField name="purge_period" type="string">
          Data retention period in days. One of: `NONE`, `7`, `30`, `90`, `180`,
          `365`.
        </ResponseField>

        <ResponseField name="meeting_default_permission" type="string">
          Default permission for new meetings. One of: `public`, `workspace`,
          `only-me`.
        </ResponseField>

        <ResponseField name="member_meeting_visibility" type="string">
          Visibility of member meetings. One of: `only-me`, `workspace-read`,
          `workspace-write`.
        </ResponseField>

        <ResponseField name="mask_sensitive_info" type="boolean">
          Whether to mask sensitive information in transcripts.
        </ResponseField>

        <ResponseField name="auto_public_on_share" type="boolean">
          Whether to automatically make meetings public when shared.
        </ResponseField>
      </Expandable>
    </ResponseField>

    <ResponseField name="allowedEmailDomains" type="string[] | null">
      List of allowed email domains for workspace access.
    </ResponseField>

    <ResponseField name="iconUrl" type="string | null">
      URL of the workspace icon.
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash curl theme={null}

  curl -X GET "https://api.caret.so/v1/workspace" \
       -H "Authorization: Bearer your_api_key_here"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch('https://api.caret.so/v1/workspace', {
    headers: {
      Authorization: 'Bearer your_api_key_here',
    },
  });

  const data = await response.json();
  console.log(data);
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.caret.so/v1/workspace"
  headers = {
      "Authorization": "Bearer your_api_key_here"
  }

  response = requests.get(url, headers=headers)
  print(response.json())
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "workspace": {
      "id": "ws_123456789",
      "name": "Acme Corp",
      "createdAt": "2023-01-01T00:00:00Z",
      "updatedAt": "2023-01-01T00:00:00Z",
      "settings": {
        "keyterms": ["technical", "documentation"],
        "audio_location": "aside-server",
        "meeting_default_permission": "workspace"
      },
      "allowedEmailDomains": ["acme.com"],
      "iconUrl": "https://example.com/icon.png"
    }
  }
  ```

  ```json 401 Unauthorized theme={null}
  {
    "error": {
      "code": "unauthorized",
      "message": "Invalid or missing API key"
    }
  }
  ```

  ```json 500 Internal Server Error theme={null}
  {
    "error": {
      "code": "internal_server_error",
      "message": "An unexpected error occurred"
    }
  }
  ```
</ResponseExample>