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}
| Address | https://api.hanzo.ai/v1/todo/projects/{key} |
| Method | GET |
| Operation | get_todo_projects_by_key |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
key | path | string | yes | Key is the project's org-unique handle: 2-8 uppercase alphanumerics starting with a letter ("ENG", "OPS2"). |
Response
| Status | Body | Meaning |
|---|---|---|
200 | todoProject | ok |
200 body — 7 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
createdAt | body | integer | — | CreatedAt is when the board was created, in unix seconds. |
description | body | string | — | Description is whatever an index board was created with. |
id | body | string | — | ID is the board's opaque handle, and it is NOT how you address it — Key is. |
key | body | string | — | Key addresses the board everywhere else — /v1/todo/projects/<key>/issues — and prefixes every issue identifier on it. |
name | body | string | — | Name is the board's display name. |
org | body | string | — | Org is the IAM org the board belongs to, taken from the validated principal and never from the request. |
updatedAt | body | integer | — | UpdatedAt 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>import { Configuration, TodoApi } from 'hanzoai';
const api = new TodoApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTodoProjectsByKey({ key: 'key' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TodoApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TodoApi(client).get_todo_projects_by_key(key='key')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.TodoAPI.GetTodoProjectsByKey(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, todo_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = todo_api::get_todo_projects_by_key(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TodoApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new TodoApi(client).getTodoProjectsByKey();curl https://api.hanzo.ai/v1/todo/projects/<key> \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches todo through the todo tool, which names its 12 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "get_todo_board"
}
}
}'How is this guide?