---
updatedAt: 2026-07-10T13:44:52.000Z
agentTools:
  projectIndex: https://docs.oneschema.co/llms.txt
---

# List Workspaces

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

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Workspaces",
    "version": "1",
    "contact": {
      "name": "OneSchema Support",
      "email": "support@oneschema.co"
    },
    "license": {
      "name": "proprietary",
      "url": "https://www.oneschema.co/terms-and-conditions"
    },
    "termsOfService": "https://www.oneschema.co/terms-and-conditions",
    "description": "An API for managing OneSchema Workspaces and Workspace sheets."
  },
  "tags": [
    {
      "name": "Workspaces",
      "description": "Workspace operations"
    }
  ],
  "paths": {
    "/v1/workspaces": {
      "get": {
        "operationId": "list-workspaces",
        "summary": "List Workspaces",
        "description": "Returns a list of all Workspaces that the authenticated user can access. Supports pagination via `offset` and `count` query parameters.",
        "parameters": [
          {
            "name": "containing_workspace_id",
            "in": "query",
            "required": false,
            "description": "Filter Workspaces by the ID of the containing Workspace. Pass `null` or an empty value to return only root-level Workspaces (those with no containing Workspace); omitting the parameter returns all accessible Workspaces.",
            "schema": {
              "type": [
                "integer",
                "null"
              ],
              "format": "int32"
            },
            "explode": false
          },
          {
            "name": "offset",
            "in": "query",
            "required": false,
            "description": "The number of Workspaces to skip before starting to collect the result set. Must be non-negative. Defaults to 0.",
            "schema": {
              "type": "integer",
              "minimum": 0
            },
            "explode": false
          },
          {
            "name": "count",
            "in": "query",
            "required": false,
            "description": "The maximum number of Workspaces to return. Must be greater than or equal to 1. Defaults to and is capped at 100.",
            "schema": {
              "type": "integer",
              "minimum": 1
            },
            "explode": false
          }
        ],
        "responses": {
          "200": {
            "description": "The request has succeeded.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/WorkspacesListResponse"
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object"
                }
              }
            }
          }
        },
        "tags": [
          "Workspaces"
        ]
      }
    }
  },
  "security": [
    {
      "ApiKeyAuth": []
    }
  ],
  "components": {
    "schemas": {
      "Workspace": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "The unique identifier of the Workspace."
          },
          "name": {
            "type": "string",
            "description": "The name of the Workspace."
          },
          "description": {
            "type": [
              "string",
              "null"
            ],
            "description": "The description of the Workspace."
          },
          "color": {
            "type": [
              "string",
              "null"
            ],
            "description": "The color of the Workspace."
          },
          "custom_metadata": {
            "type": [
              "object",
              "null"
            ],
            "description": "Custom metadata associated with the Workspace."
          },
          "containing_workspace_id": {
            "type": [
              "integer",
              "null"
            ],
            "format": "int32",
            "description": "The ID of the Workspace that contains this Workspace, if any."
          },
          "sheets": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkspaceSheet"
            },
            "description": "The sheets contained in the Workspace, included when retrieving a single Workspace."
          }
        }
      },
      "WorkspaceSheet": {
        "type": "object",
        "required": [
          "id",
          "workspace_id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "The unique identifier of the sheet."
          },
          "workspace_id": {
            "type": "integer",
            "format": "int32",
            "description": "The ID of the Workspace that contains the sheet."
          },
          "name": {
            "type": "string",
            "description": "The name of the sheet."
          },
          "template_key": {
            "type": [
              "string",
              "null"
            ],
            "description": "The unique key of the template assigned to the sheet, if any."
          },
          "custom_metadata": {
            "type": [
              "object",
              "null"
            ],
            "description": "Custom metadata associated with the sheet."
          },
          "columns": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/WorkspaceSheetColumn"
            },
            "description": "The columns of the sheet, included when the sheet's headers have been set."
          }
        }
      },
      "WorkspaceSheetColumn": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "The unique identifier of the column."
          },
          "name": {
            "type": "string",
            "description": "The label of the column."
          },
          "template_column_key": {
            "type": [
              "string",
              "null"
            ],
            "description": "The key of the template column this sheet column is mapped to, if any."
          },
          "is_custom": {
            "type": "boolean",
            "description": "Whether the column is a custom column not present in the assigned template."
          }
        }
      },
      "WorkspacesListResponse": {
        "type": "object",
        "properties": {
          "workspaces": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/Workspace"
            }
          },
          "total_count": {
            "type": "integer",
            "description": "The total number of Workspaces available for the current filter."
          }
        }
      }
    },
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "in": "header",
        "name": "X-API-KEY"
      }
    }
  },
  "servers": [
    {
      "url": "https://api.oneschema.co",
      "description": "Production server (hosted in the US)",
      "variables": {}
    },
    {
      "url": "https://api.eu.oneschema.co",
      "description": "Production server (hosted in the EU)",
      "variables": {}
    },
    {
      "url": "https://api.ca.oneschema.co",
      "description": "Production server (hosted in Canada)",
      "variables": {}
    },
    {
      "url": "https://api.au.oneschema.co",
      "description": "Production server (hosted in Australia)",
      "variables": {}
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```