Hanzo
OpenapiTodo

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

Addresshttps://api.hanzo.ai/v1/todo/board
MethodGET
Operationget_todo_board
AuthAuthorization: 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.

FieldInTypeRequiredDescription
keyquerystringKey is the project whose issues to list, from the path. EMPTY means every project in the org — the global board.
statusquerystringStatus keeps only issues in that board column: backlog, todo, in_progress, done or canceled.
kindquerystringKind keeps only work items of that shape: issue, pr or epic.
repoquerystringRepo keeps only issues bound to that git repository.
labelquerystringLabel keeps only issues carrying that label, compared case-insensitively.
sourcequerystringSource keeps only issues opened from that surface: team, git, crm, helpdesk, cms or agent.
scheduledquerybooleanScheduled keeps only issues that carry a date — a start, a due date or both.

Response

StatusBodyMeaning
200issueView[]ok

200 body — 18 fields.

FieldInTypeAlwaysDescription
[].assigneebodystringAssignee is who holds the work — an IAM username, or the login of the FIRST assignee when a forge issue has several.
[].createdAtbodyintegerCreatedAt is when the item was opened, in unix seconds.
[].descriptionbodystringDescription is the body, markdown as its author wrote it.
[].dueAtbodyintegerDueAt is when the work is due, in unix seconds; absent means no due date.
[].extRefbodystringExtRef 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.
[].idbodystringID is the work item's opaque handle, and it is NOT how you address it — ProjectKey plus Number is.
[].identifierbodystringIdentifier is the human handle, "<key>#<number>" — the board and the number on it, joined.
[].kindbodystringKind is what the item IS: issue, pr or epic. Set once at create and never changed, so a row does not migrate between surfaces.
[].labelsbodystring[]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…
[].numberbodyintegerNumber 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…
[].prioritybodystringPriority is urgent, high, medium, low or none. Also a label on a forge row.
[].projectKeybodystringProjectKey is the board this item is on: the repository name for a forge issue, the index board's key otherwise.
[].repobodystringRepo is the git repository the item is bound to, so a repository's Issues and PRs tabs are filters over this one table.
[].sourcebodystringSource is which surface OPENED it: team, git, crm, helpdesk, cms or agent. Also set once.
[].startAtbodyintegerStartAt is when the work starts, in unix seconds; absent means unscheduled.
[].statusbodystringStatus is the board column: backlog, todo, in_progress, done or canceled, and nothing else.
[].titlebodystringTitle is the item's one-line summary.
[].updatedAtbodyintegerUpdatedAt is when it last changed, in unix seconds.

Failure carries the platform error shape — see Errors.

Examples

hanzo todo board

Todo API · All Hanzo APIs · Interactive reference

How is this guide?

On this page