---
title: "List design spaces"
method: GET
path: "/spaces"
tags: ["Spaces"]
---

# List design spaces

`GET /spaces`

## Request

- Base URL: `https://api.mockflow.com/v1`
- URL: `https://api.mockflow.com/v1/spaces`
- Auth: HTTP bearer

Every space the token can see, in dashboard order: the workspace's own, the ones shared with
the person, and the two built-in spaces `default` (boards in no space) and `trash`.

## Query parameters

- `cursor` string
- `limit` integer

## Response `200`

OK

- object
  - `nextCursor` string, nullable
  - `hasMore` boolean
  - `data` Space[]
    - `id` string: A space id, or the reserved `default` and `trash`.
    - `name` string
    - `builtIn` boolean
    - `role` 'owner' | 'admin' | 'editor' | 'reviewer': The product's roles. Owner is the workspace that holds the board or space and cannot be granted or transferred. Admin can rename and share, editor can edit, reviewer can view, export and add comment items. There is no viewer role and no pending state.
    - `boardCount` integer
    - `memberCount` integer
    - `coverUrl` string, uri, nullable
    - `publicUrl` string, uri, nullable
    - `position` integer: Dashboard order, lowest first.
    - `createdBy` string, nullable
    - `createdAt` string, date-time, nullable
    - `updatedAt` string, date-time, nullable
    - `deletedAt` string, date-time, nullable

## Other responses

- `429`: Too many requests.
- `4XX`: An error. See the envelope and the code list on the Errors page.

---

[API](https://skmtc.dev/mockflow/apis/mockflow-boards-api.md) - [All operations](https://skmtc.dev/mockflow/apis/mockflow-boards-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mockflow/apis/mockflow-boards-api/revisions/1a890390518c?raw)