Get rooms
Summarises one room's work. The room is opaque here and is deliberately not resolved: this package cannot say whether a room exists — apps/team owns that…
GET /v1/todo/rooms/{room}
| Address | https://api.hanzo.ai/v1/todo/rooms/{room} |
| Method | GET |
| Operation | get_todo_rooms_by_room |
| Auth | Authorization: Bearer $HANZO_API_KEY |
Summarises one room's work.
The room is opaque here and is deliberately not resolved: this package cannot say whether a room exists — apps/team owns that document — so an unknown room answers an EMPTY board rather than a 404. That is the honest answer and the useful one: a channel that has never had an item filed in it and a channel id that was mistyped both have no work, and inventing a distinction would require this surface to hold a second copy of the room list (HIP-0523 §2 forbids it, and it would drift the first time a room was renamed).
Tenancy is the validated principal's org and nothing else, so a caller cannot read another tenant's channel by naming its room.
Request
1 field.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
room | path | string | yes | Room is the room, spelled "<workspace>_<room>" — the same value GET /v1/meet/call answers with, so a channel's call and its work name the room identically. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | roomWork | ok |
200 body — 6 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
open | body | integer | — | Open is how many items are still work: everything whose status does not end it. |
room | body | string | — | Room is the room these counts are for, echoed back as it was resolved. |
status | body | object | — | Status is the count per board column, carrying EVERY column this surface knows — an empty column reads 0 rather than being absent, so a caller can render the… |
status.* | body | integer | — | |
total | body | integer | — | Total is every item bound to this room, settled ones included, so Total minus Open is what the room has finished. |
updated | body | integer | — | Updated is when anything in this room's work last moved, in unix seconds. |
Failure carries the platform error shape — see Errors.
Examples
hanzo todo rooms get <room>import { Configuration, TodoApi } from 'hanzoai';
const api = new TodoApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTodoRoomsByRoom({ room: 'room' });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_rooms_by_room(room='room')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.TodoAPI.GetTodoRoomsByRoom(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_rooms_by_room(&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).getTodoRoomsByRoom();curl https://api.hanzo.ai/v1/todo/rooms/<room> \
-H "Authorization: Bearer $HANZO_API_KEY"MCP reaches todo through the todo tool, which names its 12 operations with its own verbs — this one among them, under a name only MCP 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?