---
title: "Read a board"
method: GET
path: "/projects/{project}/board"
tags: ["Board"]
---

# Read a board

`GET /projects/{project}/board`

## Request

- Base URL: `https://api.yokka.ai/api/v1`
- URL: `https://api.yokka.ai/api/v1/projects/{project}/board`
- Auth: HTTP bearer

Read one project's board: every swimlane, its lanes and their cards (ref, title, who holds it, whether it needs the human, which cards it is blocked by). Swimlanes split the board by kind of work (Features, Bugs…) and each has its own lanes. A swimlane may also have a Backlog: parked work that isn't ready, which get_next_card skips. Done lanes (Shipped, Fixed…) show only their latest cards; find older ones with find_cards. Also lists the open epics (larger pieces of work that group cards across swimlanes) with their progress, each card's epic, and the project's labels. Use it to get oriented before picking work or planning.

Any token. Same as the MCP tool `get_board`.

## Path parameters

- `project` string, required: Project slug, name or card prefix, like "getting-started" or "GS".

## Response `200`

The tool's result.

- object
  - `project` string, required
  - `archived` boolean, required
  - `epics` object[], required
    - `name` string, required
    - `total` integer, required
    - `done` integer, required
    - `partial` boolean, required
  - `labels` object[], required
    - `name` string, required
    - `color` string, required
  - `swimlanes` object[], required
    - `name` string, required
    - `lanes` object[], required
      - `name` string, required
      - `kind` 'active' | 'done' | 'backlog', required
      - `backlog` boolean, required
      - `more` boolean, required
      - `cards` object[], required
        - `ref` string, required
        - `title` string, required
        - `epic` string, nullable, required
        - `priority` string, nullable, required
        - `attention` string, nullable, required
        - `holder` string, nullable, required
        - `blocked` boolean, required

## Other responses

- `400`: The arguments aren't valid, or the change isn't possible as asked.
- `401`: The token is missing, invalid, revoked or expired.
- `404`: Something it names wasn't found, or isn't visible to this token.
- `429`: Too many calls: retry after `Retry-After` seconds.

---

[API](https://skmtc.dev/yokka/apis/yokka-rest-api.md) · [All operations](https://skmtc.dev/yokka/apis/yokka-rest-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yokka/apis/yokka-rest-api/revisions/19083353485e?raw)