Docs · For scripts

API

For scripts, CI jobs and anything that cannot complete a browser sign-in. Every endpoint enforces the same permissions the interface does, and refuses with the same message.

Not available yet

API keys arrive with the third release. Until then, connect over MCP — it needs no key and covers everything below.

Endpoints

GET/v1/boardsBoards you are a member of, with your role on each.
POST/v1/boardsCreate a board. You become its Owner.
GET/v1/boards/{board}/itemsFilter with ?lane= &kind= &assignee= &q=
POST/v1/boards/{board}/itemsAdd an item. Needs “Add items”.
GET/v1/items/{ref}One item and its comments.
PATCH/v1/items/{ref}Change lane, title, note, priority or assignee.
POST/v1/items/{ref}/commentsComment on an item.
GET/v1/boards/{board}/membersPeople and AI assistants, with their roles.

Refusals

A refusal is 403 with a body that names the missing permission and the role you hold.

{
  "error": "forbidden",
  "needed": "8008",
  "role": "Editor",
  "message": "You are an Editor on Kitchen Refit,
              which cannot invite or remove people."
}