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

# List workspaces

> Returns all workspaces the API key owner belongs to, ordered alphabetically by name.

<Info>Requires the `workspaces:read` scope.</Info>

## Response

Returns an array of workspace objects.

<ResponseField name="id" type="number" required>
  Workspace identifier.
</ResponseField>

<ResponseField name="name" type="string" required>
  Workspace name.
</ResponseField>

<ResponseField name="slug" type="string" required>
  URL-safe identifier for the workspace.
</ResponseField>

<ResponseField name="description" type="string | null">
  Optional workspace description.
</ResponseField>

<ResponseField name="icon" type="string | null">
  Icon identifier slug (e.g., `"folder-1"`, `"chart"`, `"briefcase"`). `null` if not set.
</ResponseField>

<ResponseField name="color" type="string | null">
  Brand color.
</ResponseField>

<ResponseField name="image_url" type="string | null">
  Workspace cover image URL.
</ResponseField>

<ResponseField name="owner_id" type="number" required>
  User ID of the workspace owner.
</ResponseField>

<ResponseField name="role" type="string" required>
  Your role in this workspace. One of `owner`, `admin`, `member`, or `viewer`.
</ResponseField>

<ResponseField name="created_at" type="string" required>
  UTC ISO-8601 creation timestamp.
</ResponseField>

<ResponseExample>
  ```json 200 theme={null}
  [
    {
      "id": 3,
      "name": "Acme Corp",
      "slug": "acme-corp",
      "description": "Main product workspace",
      "icon": "briefcase",
      "color": "blue",
      "image_url": null,
      "owner_id": 1,
      "role": "owner",
      "created_at": "2026-01-05T10:00:00.000Z"
    }
  ]
  ```

  ```json 401 theme={null}
  {
    "error": "Invalid API key"
  }
  ```

  ```json 403 theme={null}
  {
    "error": "Scope 'workspaces:read' is required for this endpoint"
  }
  ```
</ResponseExample>