Returns a board's issues — work items with their column, priority, assignee,… — GET /v1/todo/board
Returns a board's issues — work items with their column, priority, assignee, labels and schedule. WHICH board is a filter, not an address.
GET /v1/todo/board
| Address | https://api.hanzo.ai/v1/todo/board |
| Method | GET |
| Operation | get_todo_board |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Returns a board's issues — work items with their column, priority, assignee, labels and schedule.
WHICH board is a filter, not an address. Bound to a repository (the key from the path) it is that project's board; left unbound it is the org's whole board; narrowed by label it is a board smaller than any repository — which is the only way an app that lives as a directory inside a shared repository can have one. Every combination is the same rows through the same projection, so no two boards can disagree about what a column means.
The column is a LABEL on the forge, so the board and the forge web UI are the same object seen twice: relabelling in either moves the card in both. A closed issue reads as done whatever its labels say.
Request
7 fields.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
key | query | string | — | Key is the project whose issues to list, from the path. EMPTY means every project in the org — the global board. |
status | query | string | — | Status keeps only issues in that board column: backlog, todo, in_progress, done or canceled. |
kind | query | string | — | Kind keeps only work items of that shape: issue, pr or epic. |
repo | query | string | — | Repo keeps only issues bound to that git repository. |
label | query | string | — | Label keeps only issues carrying that label, compared case-insensitively. |
source | query | string | — | Source keeps only issues opened from that surface: team, git, crm, helpdesk, cms or agent. |
scheduled | query | boolean | — | Scheduled keeps only issues that carry a date — a start, a due date or both. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | issueView[] | ok |
200 body — 18 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
[].assignee | body | string | — | Assignee is who holds the work — an IAM username, or the login of the FIRST assignee when a forge issue has several. |
[].createdAt | body | integer | — | CreatedAt is when the item was opened, in unix seconds. |
[].description | body | string | — | Description is the body, markdown as its author wrote it. |
[].dueAt | body | integer | — | DueAt is when the work is due, in unix seconds; absent means no due date. |
[].extRef | body | string | — | ExtRef anchors the item to something outside the todo — a mirrored issue ("github:owner/repo#123"), a pushed PR branch, or a record on another plane. |
[].id | body | string | — | ID is the work item's opaque handle, and it is NOT how you address it — ProjectKey plus Number is. |
[].identifier | body | string | — | Identifier is the human handle, "<key>#<number>" — the board and the number on it, joined. |
[].kind | body | string | — | Kind is what the item IS: issue, pr or epic. Set once at create and never changed, so a row does not migrate between surfaces. |
[].labels | body | string[] | — | Labels are the item's remaining tags, with the status and priority labels lifted OUT — a column that stayed here would render twice, once as the card's column… |
[].number | body | integer | — | Number is the item's number ON ITS BOARD, from 1 and monotonic there — the forge's own issue number for a forge row, allocated inside the create transaction… |
[].priority | body | string | — | Priority is urgent, high, medium, low or none. Also a label on a forge row. |
[].projectKey | body | string | — | ProjectKey is the board this item is on: the repository name for a forge issue, the index board's key otherwise. |
[].repo | body | string | — | Repo is the git repository the item is bound to, so a repository's Issues and PRs tabs are filters over this one table. |
[].source | body | string | — | Source is which surface OPENED it: team, git, crm, helpdesk, cms or agent. Also set once. |
[].startAt | body | integer | — | StartAt is when the work starts, in unix seconds; absent means unscheduled. |
[].status | body | string | — | Status is the board column: backlog, todo, in_progress, done or canceled, and nothing else. |
[].title | body | string | — | Title is the item's one-line summary. |
[].updatedAt | body | integer | — | UpdatedAt is when it last changed, in unix seconds. |
Failure carries the platform error shape — see Errors.
Examples
hanzo todo boardimport { Configuration, TodoApi } from 'hanzoai';
const api = new TodoApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTodoBoard();from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TodoApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TodoApi(client).get_todo_board()cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.TodoAPI.GetTodoBoard(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, todo_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = todo_api::get_todo_board(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TodoApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new TodoApi(client).getTodoBoard();curl https://api.hanzo.ai/v1/todo/board \
-H "Authorization: Bearer $HANZO_API_KEY"Tool todo, op get_todo_board — POST the JSON-RPC envelope to https://api.hanzo.ai/v1/mcp.
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Authorization: Bearer $HANZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "todo",
"arguments": {
"op": "get_todo_board",
"input": {}
}
}
}'How is this guide?