---
title: "List Workspaces"
method: GET
path: "/v1/workspaces"
tags: ["Workspaces"]
---

# List Workspaces

`GET /v1/workspaces`

Returns a list of all Workspaces that the authenticated user can access. Supports pagination via `offset` and `count` query parameters.

## Query parameters

- `containing_workspace_id` integer, nullable
- `offset` integer
- `count` integer

## Response `200`

The request has succeeded.

- WorkspacesListResponse
  - `workspaces` Workspace[]
    - `id` integer — The unique identifier of the Workspace.
    - `name` string — The name of the Workspace.
    - `description` string, nullable — The description of the Workspace.
    - `color` string, nullable — The color of the Workspace.
    - `custom_metadata` object, nullable — Custom metadata associated with the Workspace.
    - `containing_workspace_id` integer, nullable — The ID of the Workspace that contains this Workspace, if any.
    - `sheets` WorkspaceSheet[] — The sheets contained in the Workspace, included when retrieving a single Workspace.
      - `id` integer, required — The unique identifier of the sheet.
      - `workspace_id` integer, required — The ID of the Workspace that contains the sheet.
      - `name` string, required — The name of the sheet.
      - `template_key` string, nullable — The unique key of the template assigned to the sheet, if any.
      - `custom_metadata` object, nullable — Custom metadata associated with the sheet.
      - `columns` WorkspaceSheetColumn[] — The columns of the sheet, included when the sheet's headers have been set.
        - `id` integer, required — The unique identifier of the column.
        - `name` string, required — The label of the column.
        - `template_column_key` string, nullable — The key of the template column this sheet column is mapped to, if any.
        - `is_custom` boolean — Whether the column is a custom column not present in the assigned template.
  - `total_count` integer — The total number of Workspaces available for the current filter.

## Other responses

- `400` — 400

---

[API](https://skmtc.net/oneschema/apis/templates.md) · [All operations](https://skmtc.net/oneschema/apis/templates/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneschema/templates/revisions/40674aa6d4d9/schema)