Read flow rules
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.
Request
- Base URL: https://api.yokka.ai/api/v1
- URL: https://api.yokka.ai/api/v1/projects/{project}/flow-rules
- Auth: HTTP bearer
Path parameters
Project slug, name or card prefix, like "getting-started" or "GS".
Query parameters
Swimlane name, like "Bugs". Optional; leave it out to look in every swimlane.
Response
The tool's result.
Changes
No recorded changes to this operation across all 1 revision of this API.