---
title: "List projects"
method: GET
path: "/projects"
tags: ["Board"]
---

# List projects

`GET /projects`

## Request

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

List the projects in this workspace with their swimlanes, each swimlane's lanes and how many cards each lane holds (a done lane counts its latest cards; `more` says it holds more). Start here if you don't know which project to work in. Archived projects are read-only and left out unless includeArchived.

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

## Query parameters

- `includeArchived` boolean: Also list archived (read-only) projects.

## Response `200`

The tool's result.

- object
  - `projects` object[], required
    - `name` string, required
    - `slug` string, required
    - `prefix` string, required
    - `archived` boolean, required
    - `swimlanes` object[], required
      - `name` string, required
      - `lanes` object[], required
        - `name` string, required
        - `cards` integer, required
        - `more` boolean, required
      - `backlog` integer, nullable, 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)
