API reference / CRM
Find leads
Asks the teammate who finds leads (Outreach) for people or companies that fit, in plain words: it makes a list, and the teammate looks (open places data, the web), adds the leads that fit with the page that shows it (a Fits column, which can fill itself for rows added later), then waits for review. Comment on its task to ask for more or for something else. Returns at once: the list's finder says where the task is.
/api/v1/lists/findOther ways to call it
troopy lists findtroopy_find_leadsIdempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.Body
application/jsonask*stringWho to find, in plain words: what they do, where, and what makes one a fit
At least 10 characters · At most 800 characters
kindenum<string>What each row is: companies (the default) or people
peoplecompanies
Default "companies"
namestringThe list's name; the ask's first line when left out
At least 1 characters · At most 120 characters
playenum<string>A ready-made play whose columns the list gets too, filled in (by AI, from each lead's site) as leads are added
modernizejust_raisedhiringships_abroaddecision_makers
Response
202 · 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