API reference / Tasks and projects
Read the notebook of a task
What the teammates and the people on a task tree found while they worked, newest first, 100 entries at most. The tree is the top task of the task and each task under it. Each teammate on the tree reads the notebook on the card of its task.
get
/api/v1/tasks/{key}/notebookOther ways to call it
CLI
troopy tasks notebookMCP tool
troopy_get_notebookRate limit120 calls in 60 seconds, for each key
Path parameters
key*stringA task's key (VIR-12), its number (12) or its id
At least 1 characters · At most 40 characters
Response
200 · application/jsondata*array<object>6 properties
id*stringA 24-character id
task*stringThe key of the task that it was written on, like VIR-14
by*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringtext*stringrunId*string | nullThe run of the teammate that wrote it. null for a person or a key
at*stringISO 8601 date and time
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.