API reference / Tests and incidents
List tests
The workspace's tests, most recently changed first. Filters: status (proposed, active or paused), a tag, smoke (the tests of the main path) and words in the title. Get one for its steps.
/api/v1/testsOther ways to call it
troopy tests listtroopy_list_testsQuery parameters
pageinteger1-based page number
Default 1 · At least 1
limitintegerItems per page, at most 100
Default 20 · At least 1 · At most 100
statusenum<string>proposedactivepaused
tagstringAt least 1 characters · At most 30 characters
smokeboolean | enum<string>true: only the tests of the main path
truefalse
qstringWords in the title
At least 1 characters · At most 100 characters
Response
200 · application/jsondata*array<object>13 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
pagination*object4 properties
page*integerlimit*integertotal*integerpages*integer