API reference / Tasks and projects
Get a project
One project. List its tasks with GET /tasks?project=.
get
/api/v1/projects/{id}Other ways to call it
CLI
troopy projects getMCP tool
troopy_get_projectRate limit120 calls in 60 seconds, for each key
Path parameters
id*stringA 24-character id
Response
200 · application/jsondata*object19 properties
id*stringA 24-character id
name*stringsummary*stringdescription*stringicon*stringstatus*enum<string>plannedactivepauseddonecanceled
priority*enum<string>noneurgenthighmediumlow
lead*object | null3 properties
type*enum<string>agentperson
id*stringname*stringstartAt*string | nulltargetAt*string | nulltasks*objectIts tasks, canceled ones left out
4 properties
total*integerdone*integeropen*integerneedsYou*integerprogress*integerPercent of its tasks done
milestones*array<object>Steps on the way, in order, each with its tasks (canceled ones left out)
5 properties
id*stringA 24-character id
name*stringtargetAt*string | nulltasks*object2 properties
total*integerdone*integerprogress*integerhealth*enum<string> | nullHow it's going, from its latest status update
on_trackat_riskoff_track
lastUpdateAt*string | nullcreatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
version*integerErrors
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.