Hanzo
OpenapiTodo

Answers across every project in the org.

Answers across every project in the org. The org comes from the validated principal and never from the request: a caller able to name the org could read…

GET /v1/todo/issues

Addresshttps://api.hanzo.ai/v1/todo/issues
MethodGET
Operationget_todo_issues
AuthAuthorization: Bearer $HANZO_API_KEY

Answers across every project in the org.

The org comes from the validated principal and never from the request: a caller able to name the org could read another tenant's backlog, and a search is exactly the shape that would quietly return it.

Request

8 fields.

FieldInTypeRequiredDescription
qquerystringQ matches an issue's title or description.
projectquerystringProject narrows to one team key; "" searches every project in the org, which is the point of this op.
statusquerystringStatus keeps one board column: backlog, todo, in_progress, done, canceled.
kindquerystringKind keeps one shape: issue, pr, epic.
repoquerystringRepo keeps issues bound to one git repository.
sourcequerystringSource keeps one origin: team, git, crm, helpdesk, cms, agent.
assigneequerystringAssignee keeps issues held by one person.
limitqueryintegerLimit caps the answer; 0 means the default, and anything above the ceiling is clamped rather than refused — a search that errors on being too broad teaches…

Response

StatusBodyMeaning
200issueHitsok

200 body — 12 fields.

FieldInTypeAlwaysDescription
countbodyintegerCount is how many rows Issues carries — the size of THIS answer after the cap, not how many issues matched.
issuesbodyissueHit[]Issues are the matching rows grouped by status and oldest-first within a group, capped by the search's limit (50 by default, 200 at most).
issues[].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…
issues[].kindbodystringKind is what the row IS: issue, pr or epic.
issues[].numberbodyintegerNumber is the issue's number on that board, from 1 and monotonic there.
issues[].prioritybodystringPriority is urgent, high, medium, low or none.
issues[].projectbodystringProject is the board key the issue is on.
issues[].repobodystringRepo is the git repository the issue is bound to, empty when it is not repo-bound.
issues[].sourcebodystringSource is which surface opened it: team, git, crm, helpdesk, cms or agent.
issues[].statusbodystringStatus is the board column: backlog, todo, in_progress, done or canceled.
issues[].titlebodystringTitle is the issue's one-line summary — what the q filter matched, along with the description.
issues[].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 issues

Todo API · All Hanzo APIs · Interactive reference

How is this guide?

On this page