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

# Get Workspace

> Return basic workspace metadata (id, name, slug, icon).

## Method

`GET` `/v1/workspaces/:id`

## Path Parameters

<ParamField path="id" type="uuid" required>Workspace identifier. Must match the workspace associated with the API key.</ParamField>

## Headers

<ParamField header="Authorization" type="string">Bearer token with `workspaces:read` scope.</ParamField>

## Request Example

<RequestExample>
  ```bash cURL theme={null}
  curl "https://api.voyantcloud.com/v1/workspaces/ws_abc" \
    -H "Authorization: Bearer $VOYANT_API_KEY"
  ```

  ```javascript Node.js theme={null}
  const res = await fetch("https://api.voyantcloud.com/v1/workspaces/ws_abc", {
    headers: { Authorization: `Bearer ${process.env.VOYANT_API_KEY}` },
  })
  const body = await res.json()
  ```

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

  resp = requests.get(
    "https://api.voyantcloud.com/v1/workspaces/ws_abc",
    headers={"Authorization": f"Bearer {os.environ['VOYANT_API_KEY']}"},
  )
  workspace = resp.json()
  ```
</RequestExample>

## Response

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "data": {
      "id": "ws_abc",
      "name": "Voyant Travel",
      "slug": "voyant-travel",
      "icon_asset_id": "asset_123"
    }
  }
  ```

  ```json 403 Forbidden theme={null}
  { "error": "Access denied", "code": "AUTH_403" }
  ```

  ```json 404 Not Found theme={null}
  { "error": "Workspace not found", "code": "NOT_FOUND_404" }
  ```
</ResponseExample>

<Tip>The API validates that the requested `:id` matches the workspace in the API key context. Service accounts operating across multiple workspaces must rotate keys or proxy requests through an internal service.</Tip>