API reference / Tests and incidents
Get a test
One test with its steps.
get
/api/v1/tests/{id}Other ways to call it
CLI
troopy tests getMCP tool
troopy_get_testRate limit120 calls in 60 seconds, for each key
Path parameters
id*stringA 24-character id
Response
200 · application/jsondata*object13 properties
id*stringA 24-character id
title*stringsteps*array<object>3 properties
id*strings1, s2 and so on, in order
kind*enum<string>do: an action. check: what must show. picture: a picture to take
docheckpicture
text*stringtags*array<string>smoke*booleanOn the main path: it runs after each release
production*booleanSafe for Production: no step changes data
account*string | nullThe label of the test account that it signs in with. null when it signs in with none
status*enum<string>A teammate's test is proposed until a person makes it active. A paused test does not run
proposedactivepaused
createdBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringversion*integercreatedAt*stringISO 8601 date and time
updatedAt*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.