---
title: "List boards"
method: GET
path: "/boards"
tags: ["Boards"]
---

# List boards

`GET /boards`

## Request

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

Boards the token can read: the workspace's own, boards shared with the person, and boards in
spaces shared with them. Inside a space the default order is the dashboard's manual order;
otherwise most recently updated first. `deleted=true` lists the workspace's own trash.

## Query parameters

- `spaceId` string
- `q` string
- `deleted` boolean
- `sort` 'position' | 'updatedAt' | 'createdAt' | 'title'
- `order` 'asc' | 'desc'
- `cursor` string
- `limit` integer

## Response `200`

OK

- object
  - `nextCursor` string, nullable
  - `hasMore` boolean
  - `data` Board[]
    - `id` string
    - `title` string
    - `spaceId` string, nullable: The design space, or null for the default space.
    - `url` string, uri: Opens the board in the editor.
    - `publicUrl` string, uri, nullable: The public viewer link, when the public link is on.
    - `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.
    - `locked` boolean: Locked boards are read only for everyone.
    - `position` integer, nullable: Manual order inside the space, lowest first.
    - `createdBy` string
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `deletedAt` string, date-time, nullable: Set while the board is in the trash.

## 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)