Hanzo
OpenapiTodo

Returns one board of your org by its key — the repository name.

Returns one board of your org by its key — the repository name.

GET /v1/todo/projects/{key}

Addresshttps://api.hanzo.ai/v1/todo/projects/{key}
MethodGET
Operationget_todo_projects_by_key
AuthAuthorization: Bearer $HANZO_API_KEY

Returns one board of your org by its key — the repository name. 404 when your org has no repository under that key, or when your own forge account cannot see it.

Request

1 field.

FieldInTypeRequiredDescription
keypathstringyesKey is the project's org-unique handle: 2-8 uppercase alphanumerics starting with a letter ("ENG", "OPS2").

Response

StatusBodyMeaning
200todoProjectok

200 body — 7 fields.

FieldInTypeAlwaysDescription
createdAtbodyintegerCreatedAt is when the board was created, in unix seconds.
descriptionbodystringDescription is whatever an index board was created with.
idbodystringID is the board's opaque handle, and it is NOT how you address it — Key is.
keybodystringKey addresses the board everywhere else — /v1/todo/projects/<key>/issues — and prefixes every issue identifier on it.
namebodystringName is the board's display name.
orgbodystringOrg is the IAM org the board belongs to, taken from the validated principal and never from the request.
updatedAtbodyintegerUpdatedAt is when the board record last changed, in unix seconds — the BOARD, not the work on it, so filing an issue does not move it.

Failure carries the platform error shape — see Errors.

Examples

hanzo todo projects get <key>

Todo API · All Hanzo APIs · Interactive reference

How is this guide?

On this page