Hanzo
OpenapiTodo

Opens a work item on the board — an issue on that repository on the…

Opens a work item on the board — an issue on that repository on the deployment's forge, filed as YOU.

POST /v1/todo/projects/{key}/issues

Addresshttps://api.hanzo.ai/v1/todo/projects/{key}/issues
MethodPOST
Operationpost_todo_projects_by_key_issues
AuthAuthorization: Bearer $HANZO_API_KEY

Opens a work item on the board — an issue on that repository on the deployment's forge, filed as YOU.

The column and priority are written as LABELS, which is what makes the card and the forge issue the same object: someone relabelling in the forge web UI has moved your card.

Request

6 fields, body application/json (required).

FieldInTypeRequiredDescription
keypathstringyesKey is the board — the repository name, from the path.
descriptionbodystringDescription becomes the issue body.
keybodystringKey is the board — the repository name, from the path.
prioritybodystringPriority is one of none, urgent, high, medium or low.
statusbodystringStatus is the board column to open into: backlog, todo, in_progress, done or canceled.
titlebodystringTitle is required.

Response

StatusBodyMeaning
200issueViewok

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 projects issues create <key>

Todo API · All Hanzo APIs · Interactive reference

How is this guide?

On this page