---
title: "Read flow rules"
method: GET
path: "/projects/{project}/flow-rules"
tags: ["Structure"]
---

# Read flow rules

`GET /projects/{project}/flow-rules`

## Request

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

Read each swimlane's flow rules: what the board does when an agent claims, reports, asks, completes or releases a card (move it to a lane, flag it for the human), and auto-start rules (on entered: start an agent on a runner when a card enters `lane`; set up in the app). Rules run in order. Their ids are what update_flow_rule and remove_flow_rule take.

Needs a token with the `board.manage` permission. Without it: *This token can't change lanes, swimlanes or flow rules. Ask the human to do it, or to create a token with that permission turned on.* Same as the MCP tool `get_flow_rules`.

## Path parameters

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

## Query parameters

- `swimlane` string: Swimlane name, like "Bugs". Optional; leave it out to look in every swimlane.

## Response `200`

The tool's result.

- object
  - `swimlanes` object[], required
    - `name` string, required
    - `rules` object[], required
      - `id` string, required
      - `on` string, required
      - `moveTo` string, nullable, required
      - `setAttention` string, nullable, required
      - `lane` string, nullable, required
      - `start` string, nullable, required
      - `enabled` 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.
- `403`: The token can't do this, or a plan or board limit was reached.
- `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)