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

# List Workspaces

`GET /api/v1/workspaces`

Lists all workspaces in the organization.

Args:
    workspace_filter_model: Filter model used for pagination, sorting,
        filtering,
    hydrate: Flag deciding whether to hydrate the output model(s)
        by including metadata fields in the response.

Returns:
    A list of workspaces.

## Query parameters

- `hydrate` boolean
- `sort_by` string
- `logical_operator` 'or' | 'and' — Logical Ops to use to combine filters on list methods.
- `page` integer
- `size` integer
- `id` union
  - string, uuid
  - string
- `created` union
  - string, date-time
  - string
- `updated` union
  - string, date-time
  - string
- `name` string, nullable

## Response `200`

Successful Response

- PageWorkspaceResponse
  - `index` integer, required
  - `max_size` integer, required
  - `total_pages` integer, required
  - `total` integer, required
  - `items` WorkspaceResponse[], required
    - `body` WorkspaceResponseBody — Response body for workspaces.
      - `created` string, date-time, required
      - `updated` string, date-time, required
    - `metadata` WorkspaceResponseMetadata — Response metadata for workspaces.
      - `description` string
    - `resources` WorkspaceResponseResources — Class for all resource models associated with the workspace entity.
    - `id` string, uuid, required
    - `permission_denied` boolean
    - `name` string, required

## Other responses

- `401` — Unauthorized
- `404` — Not Found
- `422` — Unprocessable Entity

---

[API](https://skmtc.net/zenml-io/apis/zenml-2.md) · [All operations](https://skmtc.net/zenml-io/apis/zenml-2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/zenml-io/zenml-2/versions/febb01b8bce3/schema)