API reference / CRM
Read a list's rows
A window of a list's rows, filtered (every filter must pass), searched and sorted: rows with a value in the sort column first, empty ones after. Send the rev you have: if nothing changed since, same is true and no rows come back.
/api/v1/lists/{id}/rows/queryOther ways to call it
troopy lists rowstroopy_query_list_rowsPath parameters
id*stringA 24-character id
Body
application/jsonwherearray<object>At most 10 items
3 properties
column*stringA column's id
At most 40 characters
op*enum<string>isis_notcontainsgtltemptynot_empty
valuestring | number | booleanWhat to compare with; none for empty and not_empty
sortobject2 properties
column*stringAt most 40 characters
dir*enum<string>ascdesc
qstringText to find in names, emails, companies and titles
At least 1 characters · At most 100 characters
offsetintegerDefault 0 · At least 0 · At most 100000
limitintegerDefault 100 · At least 1 · At most 500
revintegerResponse
200 · application/jsondata*object5 properties
same*booleanrev*integertotal*integer | nullRows that pass the filters: with the first window (offset 0) and with a read that sent a rev; null with the others
rows*array<object>5 properties
id*stringA 24-character id
recordId*stringIts person or company
values*objectValues by column id; long text is in texts
texts*objectLong text by column id: the first 200 characters in a window of rows, whole for one row
cells*objectWork columns' cells by column id: queued, working, filled, nothing found or failed, and why
runs*array<object>Work columns running on the list now (none when same: keep what you had): read again every few seconds while there are any
13 properties
id*stringA 24-character id
list*stringA 24-character id
column*stringstatus*enum<string>running: poll statusUrl every few seconds
runningdonestoppedfailed
total*integerRows it works on
done*integerRows it filled
none*integerRows it found nothing for
failed*integerRows that failed
note*string | nullWhile it waits: what for, and until when
error*string | nullby*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
finishedAt*string | null