---
title: "List workspaces"
method: GET
path: "/api/projects/{projectId}/workspaces/"
tags: ["Workspaces"]
---

# List workspaces

`GET /api/projects/{projectId}/workspaces/`

List workspaces. Returns the requested resource or collection for the authenticated caller.

## Path parameters

- `projectId` string, required

## Response `200`

Workspaces

- WorkspacesResponse — workspaces Response payload returned by the API.
  - `workspaces` Workspace[], required — Collection of workspace values.
    - `id` string, required — Stable identifier for the object.
    - `projectId` string, required — Project identifier that owns or scopes this object.
    - `path` string, required — File system path or repository-relative path.
    - `displayName` string, nullable — Optional display name shown to users.
    - `sourceType` string, required — source Type value for the workspace object.
    - `autoGenerated` boolean, required — auto Generated value for the workspace object.
    - `status` string, required — Current status value.
    - `errorMessage` string, nullable — Detailed error message, when present.
    - `createdAt` string, date-time, required — Time when the object was created.
    - `updatedAt` string, date-time, required — Time when the object was last updated.

---

[API](https://skmtc.net/ibuildthecloud/apis/discobot-server-api.md) · [All operations](https://skmtc.net/ibuildthecloud/apis/discobot-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ibuildthecloud/discobot-server-api/versions/4de3fcd6be56/schema)