---
title: "List spaces"
method: GET
path: "/api/w/{wId}/spaces"
tags: ["Private Spaces"]
---

# List spaces

`GET /api/w/{wId}/spaces`

Returns all spaces in the workspace.

## Path parameters

- `wId` string, required

## Query parameters

- `role` string
- `kind` string[]

## Response `200`

Success

- object
  - `spaces` union[]
    - union
      - PrivateSpace — A space in the workspace.
        - `sId` string, required
        - `name` string, required
        - `kind` 'global' | 'system' | 'conversations' | 'regular' | 'project', required
        - `groupIds` string[], required
        - `isRestricted` boolean, required
        - `managementMode` 'manual' | 'group', required
        - `createdAt` integer
        - `updatedAt` integer
      - PrivateProject — A space in the workspace.
        - `sId` string, required
        - `name` string, required
        - `kind` 'global' | 'system' | 'conversations' | 'regular' | 'project', required
        - `groupIds` string[], required
        - `isRestricted` boolean, required
        - `managementMode` 'manual' | 'group', required
        - `createdAt` integer
        - `updatedAt` integer
        - `description` string, nullable
        - `isMember` boolean
        - `archivedAt` integer, nullable
        - `todoGenerationEnabled` boolean — Whether automatic todo suggestions from project activity are enabled.
        - `lastTodoAnalysisAt` integer, nullable — Unix timestamp (ms) of the last automatic todo suggestion scan, if any.
        - `pinnedFramePath` string, nullable — Scoped path to the frame file pinned as the Pod banner (e.g. project/banner.html).
        - `frameTabs` object[] — Frames promoted as custom Pod tabs (shared for all members).
          - `path` string, required — Canonical scoped path to the frame file in the Pod filesystem.
          - `title` string, required — Display title for the tab.
          - `icon` string, required — Action icon name (e.g. ActionDashboardIcon).
        - `tabsOrder` string[] — Interleaved system tab ids and frame paths before Settings.
        - `isAdminControlled` boolean — Whether workspace admins control membership and connected data for this Pod.

## Other responses

- `401` — Unauthorized

---

[API](https://skmtc.net/dust-tt/apis/dust-api-documentation.md) · [All operations](https://skmtc.net/dust-tt/apis/dust-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dust-tt/dust-api-documentation/revisions/dcb3503f04c9/schema)
