API reference / CRM
Get a list
One list: its columns, in order, and its rev. Read its rows with POST /lists/{id}/rows/query.
/api/v1/lists/{id}Other ways to call it
troopy lists gettroopy_get_listPath parameters
id*stringA 24-character id
Response
200 · application/jsondata*object11 properties
id*stringA 24-character id
name*stringkind*enum<string>peoplecompanies
rows*integercreatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringupdatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time
columns*array<object>8 properties
id*stringA standard column's field (name, email, title...) or c1, c2... for the list's own
name*stringtype*enum<string>textnumberdateselectmulti_selecturlcheckboxemailphonelong_text
options*array<object>3 properties
id*stringIts name: a select's value is its option's name
name*stringcolor*enum<string>stoneskymintsandrosepeachcyanorange
width*integerhidden*booleanstandard*booleanThe record's own field, the same on every list it is on; it can be hidden, not deleted
work*object | nullWhat it works out when it runs, for a work column; null for the rest
3 properties
kind*"ai"ask*stringWhat to work out for each row, in plain words
At least 1 characters · At most 1000 characters
read*booleanRead each row's website (its home, contact, about and team pages) first
Default false
rev*integerGoes up with every change to its rows: send it back to read rows only when something changed
finder*object | nullThe teammate asked to find its rows (POST /lists/find), and where its task is
4 properties
handle*stringThe teammate's handle
name*stringtask*stringIts task's key, like VIR-12: comment there to ask for more or for something else
status*enum<string>backlogtodoin_progressneeds_youin_reviewdonecanceled