List issues — GET /v1/task/projects/{key}/issues

Returns a board's issues — work items with their column, priority, assignee, labels and schedule.

GET /v1/task/projects/{key}/issues

Addresshttps://api.hanzo.ai/v1/task/projects/{key}/issues
MethodGET
Operationget_task_projects_by_key_issues
AuthAuthorization: Bearer $HANZO_API_KEY

Returns a board's issues — work items with their column, priority, assignee, labels and schedule.

WHICH board is a filter, not an address. Bound to a repository (the key from the path) it is that project's board; left unbound it is the org's whole board; narrowed by label it is a board smaller than any repository — which is the only way an app that lives as a directory inside a shared repository can have one. Every combination is the same rows through the same projection, so no two boards can disagree about what a column means.

The column is a LABEL on the forge, so the board and the forge web UI are the same object seen twice: relabelling in either moves the card in both. A closed issue reads as done whatever its labels say.

Request

7 fields.

FieldInTypeRequiredDescription
keypathstringyesKey is the project whose issues to list, from the path.
statusquerystring—Status keeps only issues in that board column: backlog, todo, in_progress, done or canceled.
kindquerystring—Kind keeps only work items of that shape: issue, pr or epic.
repoquerystring—Repo keeps only issues bound to that git repository.
labelquerystring—Label keeps only issues carrying that label, compared case-insensitively.
sourcequerystring—Source keeps only issues opened from that surface: team, git, crm, helpdesk, cms or agent.
scheduledqueryboolean—Scheduled keeps only issues that carry a date — a start, a due date or both.

Response

StatusBodyMeaning
200task.issueView[]ok
defaultproblem-detailsrefused

200 body — 19 fields.

FieldInTypeAlwaysDescription
[].assigneebodystring—Assignee is who holds the work — an IAM username, or the login of the FIRST assignee when a forge issue has several.
[].createdAtbodyinteger (int64)—CreatedAt is when the item was opened, in unix seconds.
[].descriptionbodystring—Description is the body, markdown as its author wrote it.
[].dueAtbodyinteger (int64)—DueAt is when the work is due, in unix seconds; absent means no due date.
[].extRefbodystring—ExtRef anchors the item to something outside the task — a mirrored issue ("github:owner/repo#123"), a pushed PR branch, or a record on another plane.
[].idbodystring—ID is the work item's opaque handle, and it is NOT how you address it — ProjectKey plus Number is.
[].identifierbodystring—Identifier is the human handle, "<key>#<number>" — the board and the number on it, joined.
[].kindbodystring—Kind is what the item IS: issue, pr or epic.
[].labelsbodystring[]—Labels are the item's remaining tags, with the status and priority labels lifted OUT — a column that stayed here would render twice, once as the card's column and once as a chip on the card.
[].numberbodyinteger (int64)—Number is the item's number ON ITS BOARD, from 1 and monotonic there — the forge's own issue number for a forge row, allocated inside the create transaction for an index row so it cannot race.
[].prioritybodystring—Priority is urgent, high, medium, low or none.
[].projectKeybodystring—ProjectKey is the board this item is on: the repository name for a forge issue, the index board's key otherwise.
[].repobodystring—Repo is the git repository the item is bound to, so a repository's Issues and PRs tabs are filters over this one table.
[].sourcebodystring—Source is which surface OPENED it: team, git, crm, helpdesk, cms or agent.
[].startAtbodyinteger (int64)—StartAt is when the work starts, in unix seconds; absent means unscheduled.
[].statusbodystring—Status is the board column: backlog, todo, in_progress, done or canceled, and nothing else.
[].titlebodystring—Title is the item's one-line summary.
[].updatedAtbodyinteger (int64)—UpdatedAt is when it last changed, in unix seconds.
[].urlbodystring—URL is where a person reads the item: its page on the forge or on GitHub.

Failure carries the platform error shape — see Errors.

Examples

hanzo task projects issues list <key>
import { Configuration, TaskApi } from 'hanzoai';

const api = new TaskApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getTaskProjectsByKeyIssues({ key: 'key' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import TaskApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = TaskApi(client).get_task_projects_by_key_issues(key='key')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.TaskAPI.GetTaskProjectsByKeyIssues(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, task_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = task_api::get_task_projects_by_key_issues(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.TaskApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new TaskApi(client).getTaskProjectsByKeyIssues();
curl https://api.hanzo.ai/v1/task/projects/<key>/issues \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches task through the task tool, which names its 10 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_task_board"
         }
       }
     }'

Task API · All Hanzo APIs · Interactive reference

Was this page useful?