Hanzo
OpenapiTodo

Takes an issue: it becomes yours and it moves to in_progress.

Takes an issue: it becomes yours and it moves to in_progress. The holder is the CALLER, never an argument.

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

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

Takes an issue: it becomes yours and it moves to in_progress.

The holder is the CALLER, never an argument. "Assign this to someone else" is a different act with different authority, and it already exists as a PATCH; conflating them would let anyone hand work to anyone by naming them.

Claiming something already held by someone else is refused rather than silently taken — two agents on one issue is the failure this prevents, and a claim that quietly wins a race is worse than one that says no.

Request

2 fields.

FieldInTypeRequiredDescription
keypathstringyes
numpathintegeryes

Response

StatusBodyMeaning
200issueHitok

200 body — 10 fields.

FieldInTypeAlwaysDescription
assigneebodystringAssignee is who holds the work. EMPTY MEANS UNHELD, which is what makes the issue claimable: claiming one already held by someone else is refused with 409…
kindbodystringKind is what the row IS: issue, pr or epic.
numberbodyintegerNumber is the issue's number on that board, from 1 and monotonic there.
prioritybodystringPriority is urgent, high, medium, low or none.
projectbodystringProject is the board key the issue is on.
repobodystringRepo is the git repository the issue is bound to, empty when it is not repo-bound.
sourcebodystringSource is which surface opened it: team, git, crm, helpdesk, cms or agent.
statusbodystringStatus is the board column: backlog, todo, in_progress, done or canceled.
titlebodystringTitle is the issue's one-line summary — what the q filter matched, along with the description.
urlbodystringURL is the row's external anchor — its extRef — which is a link only when the feeder sent one.

Failure carries the platform error shape — see Errors.

Examples

hanzo todo projects issues claim <key> 1

Todo API · All Hanzo APIs · Interactive reference

How is this guide?

On this page