Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Troop

List runs

Teammates' runs in the workspace, newest first: what started each, how it went and a one-line summary. Filter by teammate, status, what started it, the schedule that started it, or when.

get/api/v1/runs

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

Query parameters

pageinteger

1-based page number

Default 1 · At least 1

limitinteger

Items per page, at most 100

Default 20 · At least 1 · At most 100

agentstring

The teammate's handle, like chief

At most 40 characters

statusenum<string>

queuedrunningdonefailed

triggerenum<string>

Only runs started this way, like routine

chatroutinehandoffhiresetuptasktroop

routinestring

Only the runs of this routine

sincestring

Only runs started at or after this time

date-time

Response

200 · application/json
data*array<object>
17 properties
id*string

A 24-character id

agent*string
kind*enum<string>

compile_profile: the lead writing the short form of the long memory files; summarize: a teammate keeping the summary of a long conversation; translate: the Support agent translating the messages of a support chat, for Live translate; dream: the lead linking the notes of the brain, and inferring a few facts from them; learn_facts: the lead reading the facts of docs, web pages and files into Memories; watch_sessions: a teammate reads the sessions of visitors, and names the problems that they show; draft_brand: the lead drafting the empty lines of the brand from its website; classify_feedback: a teammate suggests the type and the themes of what customers said; fill_column: a batch of a list's AI column; triage: the lead's quick read of a troop chat message naming no teammate; distill: the lead reading what people said, for facts to keep: what they said to teammates, and their own talk with learnFromTalk; write_emails: a batch of a campaign's emails, written for each person; lessons: a teammate writing down what a finished task taught it (learnFromWork); write_rebuttal: a teammate writing the answer to a Stripe dispute, which Troopy checks against the records; read_photo: the lead reading the notes of a photo of a board onto a canvas

workdraft_roledraft_memorydraft_skilldraft_selffill_columntriagedistillwrite_emailslessonswrite_rebuttalclassify_feedbackdraft_brandread_photowatch_sessionslearn_factsand 4 more

trigger*object
5 properties
type*enum<string>

What started it: a message, a routine, a teammate handing work over, drafting a role, setting up memory after onboarding, a task, a message in the troop chat, a list's work column, the emails of a campaign, incidents to look at, a dispute to answer, what customers said to sort, a look at the sessions of visitors, documents whose facts wait for a read, a photo of a board to read onto a canvas, or a support chat with Live translate on

chatroutinescreenhandoffhiresetuptasktroopcolumncampaignincidentdisputecustomerssessionsbraincanvasand 1 more

threadId*string | null
routineId*string | null
fromRunId*string | null

The run that handed this work over

troopThreadId*string | null

A message in the troop chat: the thread it answers in, named by the thread's first message

taskId*string | null

The task it worked on

task*string
status*enum<string>

queued or running: poll statusUrl every few seconds

queuedrunningdonefailed

roleVersion*integer
summary*string

One line on what it did

error*string | null
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

toolCalls*integer
skills*array<string>

The skills it used, by name: asked for with /name at the start of a message, then opened

requestedBy*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
createdAt*string

ISO 8601 date and time

finishedAt*string | null
statusUrl*string
pagination*object
4 properties
page*integer
limit*integer
total*integer
pages*integer

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