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

# List all workspaces

`GET /workspaces`

Lists all workspaces that have been added by a user.

It is **strongly RECOMMENDED** to keep the response size small by
omitting all optional non-scalar values (i.e. arrays and objects) from objects in `workspaces`.
To get the full metadata for a workspace clients MUST request `GET /workspaces/{workspace_id}`.

## Parameters

- `../../openapi.yaml#/components/parameters/pagination_limit` — unresolved $ref

## Response `200`

Array of workspace descriptions

- object
  - `workspaces` Workspace[], required
    - union
      - object — The workspace is not available, e.g. because it's still provisioning it or the back-end can't connect to it / lost the connection / has been deleted externally, ...
        - `id` string, required
        - `title` string — A short title for the workspace.
        - `description` string, commonmark — A description that describes the workspace. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
        - `type` string, required — The workspace provider name as defined in `GET /workspace_providers`.
        - `status` 'provisioning' | 'unavailable', required — The status of the workspace.
        - `details` string — A status message (e.g. error message) or any other free-text information about the workspace.
        - `quota` MaxStorageQuota — unresolved $ref
      - object
        - `id` string, required
        - `title` string — A short title for the workspace.
        - `description` string, commonmark — A description that describes the workspace. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
        - `type` string, required — The workspace provider name as defined in `GET /workspace_providers`.
        - `status` 'ready', required — The status of the workspace.
        - `details` string — A status message (e.g. error message) or any other free-text information about the workspace.
        - `quota` MaxStorageQuota — unresolved $ref
        - `url` string, uri — The URL of the actual workspace, e.g. a bucket URL.
        - `properties` WorkspaceProperties — Any additional metadata of the workspace provided by the workspace provider. The structure is not specified by the API.
        - `free` StorageQuotaFree — unresolved $ref
  - `links` LinksPagination, required — unresolved $ref

## Other responses

- `4XX` — unresolved $ref
- `5XX` — unresolved $ref

## Changes

- **2024-09-09** `3b338366e33b` — 1 warning, 1 info
  - removed the optional property `workspaces/items/oneOf[subschema #2: Ready]/credentials` from the response with the `200` status
  - added the required property `workspaces/items/type` to the response with the `200` status
- **2023-12-01** `90d7a6531a39` — 2 info
  - added the optional property `workspaces/items/description` to the response with the `200` status
  - added the optional property `workspaces/items/title` to the response with the `200` status
- **2023-10-11** `c3433de805e9` — 1 breaking, 2 warning, 1 info
  - removed the required property `workspaces/items/type` from the response with the `200` status
  - removed the optional property `workspaces/items/description` from the response with the `200` status
  - removed the optional property `workspaces/items/title` from the response with the `200` status
  - added the optional property `workspaces/items/oneOf[subschema #2: Ready]/credentials` to the response with the `200` status

[Change history](https://skmtc.dev/open-eo/apis/openeo-api-workspaces-extension/changes/workspaces/get.md)

---

[API](https://skmtc.dev/open-eo/apis/openeo-api-workspaces-extension.md) · [All operations](https://skmtc.dev/open-eo/apis/openeo-api-workspaces-extension/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/open-eo/openeo-api-workspaces-extension/revisions/6f92902ecf78/schema)