Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Tasks and projects

Get the tree of a task

Who started whom: the top task of a task, and each task under it that a teammate has, with the work of that teammate. A teammate hands a part of its task to another teammate, so the tree goes deeper than the sub-tasks of the board.

get/api/v1/tasks/{key}/tree

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy tasks tree
MCP tooltroopy_get_task_tree
Rate limit120 calls in 60 seconds, for each key

Path parameters

key*string

A task's key (VIR-12), its number (12) or its id

At least 1 characters · At most 40 characters

Response

200 · application/json
data*object
2 properties
top*string

The key of the top task: the root of the tree

nodes*array<object>

The top task first, then each task under it that a teammate has, in the order they were made

14 properties
key*string

Its key, like VIR-12

title*string
status*enum<string>

backlogtodoin_progressneeds_youin_reviewdonecanceled

from*string | null

The key of the task that started it: the task that handed it on, else its parent. null for the top task

assignee*object | null
3 properties
type*enum<string>

agentperson

id*string
name*string
state*enum<string>

Its status, or working, queued, or waiting (for the work that it handed on)

backlogtodoin_progressneeds_youin_reviewdonecanceledworkingqueuedwaiting

doing*string | null

What its teammate says it does now, in its own few words

runId*string | null

The run on it now, else its last run

model*string | null

The model of its last round, like Sonnet 5.5. null before its first round

families*array<enum<string>>

The families of the tools that its runs called, in the order of their first call

browserbrainhelptasksskillsinboxbrain_editsemailhiringroutinescanvasesresearchbrandwebpicturesleadsand 13 more

steps*integer

The tool calls of its runs

ms*integer

The time that its runs worked, in milliseconds, without the run on it now

since*string | null

When the run on it now started: its time goes on from there

usd*number | null

What its rounds cost in USD, on AI plans that bill each use. null on other plans

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
429 rate_limitedWait the number of seconds in Retry-After, then retry.