Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Troop

List teammates

The workspace's troop, its lead first, with what each is doing now. Every workspace starts with a Chief of Staff (handle chief).

get/api/v1/agents

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 agents list
MCP tooltroopy_list_agents
Rate limit120 calls in 60 seconds, for each key

Response

200 · application/json
data*array<object>
15 properties
handle*string
name*string
role*string

The role it was hired into, like writer, or custom

title*string

The job, like Content writer

tagline*string

What it does, in a few words, like Writes emails, articles and web copy in your voice

area*enum<string>

The area it works in: engineering, marketing or operations; lead for the troop's lead

leadengineeringmarketingoperations

lead*boolean

The troop's lead, whom a conversation goes to unless it names another teammate

avatar*object

Its face: a bot-avatars body type, colour (#RRGGBB), face and shading, a robot head, or an object with two eyes

6 properties
shape*enum<string>

cloverflowertrianglesquareblobghostcircledropstardroidmechalienhexagoncatcloudpilland 2 more

color*string
face*enum<string>

eyesmouth

shadingenum<string>

How its body is lit; fabric when unset

fabricplasticcrispsmoothflat

robotobject

A TV-headed robot (robot-heads) in place of the bot. shape, color, face and shading stay for the bot

5 properties
shape*enum<string>

rectanglesquarecirclehexagon

shell*string

The colour of its shell

trim*string

The colour of its ears and of the collar of its antenna

screen*string

The colour of the lights on its screen

antenna*boolean
objectobject

An object with two eyes in place of the bot. shape, color, face and shading stay for the bot

2 properties
shape*enum<string>

circlesquaretrianglepilldrophexagonpentagoncloudbeancloverflowersparkleburstapplechatbulband 13 more

color*string

The colour of the object

status*enum<string>

working: a run is going. paused: it won't start runs until resumed

idleworkingpaused

needsYou*boolean

It waits on a person: a task of its own waits in Needs you (a question, or a call to approve), or a call of its own waits for a yes (GET /approvals)

lastActiveAt*string | null

When it last finished a run

doing*string | null

While it works: what it is doing, in its own few words, like "Checking Acme's payment terms"; null before its first step says

plan*string | null

The id of the AI plan it starts on; null follows the organization's default

model*string | null

The model it runs on, from its plan's list (GET /ai-plans/{plan}/models); null uses the plan's model

effort*enum<string> | null

How hard its model thinks, one that its model takes; null uses the plan's effort on the plan's model, else the model's default

lowmediumhighxhighmax

Errors

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.
429 rate_limitedWait the number of seconds in Retry-After, then retry.