tools/list shows what your credential allows, not the whole
catalogue.
Use names, not ids.
search_people and update_person take audience names, and radar
takes a source display_name. An unknown name answers with the names that exist.People and companies
search_people
Find people on any combination of profile, fit, warmth, recency and outreach count.string
Free text over name, headline, title, company, location and industry. A pasted profile URL
matches that one person.
number
Engaged in the last N days.
number
Fit score floor, 0 to 100.
number
Ceiling on times approached.
0 means never approached.string
An audience name, not an id.
string
A
post_id. Answers “who engaged with this one post”.total, a compact row per person and next_cursor.
Use next get_person to open one. update_person or log_outreach to act.
All parameters
All parameters
search, country, seniority, industry, stage, min_fit, max_fit,
min_followers, min_connections, max_outreach_count, days, engaged_since,
first_engaged_since, audience, engaged_with_post, comment_contains, company_id,
sort, limit, cursor.With engaged_with_post each row also carries the engagement itself. The other filters
do not apply to that question.get_person
Everything about one person, right before you write to them.string
The id from a search row.
string
A name instead of an id.
string
A profile URL instead of an id.
log_outreach after you send something. update_person to change their stage.
All parameters and the candidates answer
All parameters and the candidates answer
Also
activity_limit and outreach_limit.A name that matches several people answers with candidates instead. Pick one and ask
again with its id. That is an answer, not an error.search_companies
Companies where several of your people work, and who works at one of them.string
One company, with the people from your workspace who work there.
string
Free text over the company name.
number
Only companies with at least this many of your people.
number
Fit score floor, 0 to 100.
get_person on one of the people that came back.
All parameters
All parameters
company_id, search, industry, country, min_fit, min_people, size_min,
size_max, sort, limit, cursor.Content and numbers
list_posts
Your own posts with their numbers.string
A UTC day,
YYYY-MM-DD.string
Free text in the post body.
Leave reshares out.
string
How to order the page.
search_people with engaged_with_post set to a post_id from one of these
rows.
All parameters
All parameters
sort, posted_since, search, exclude_reshares, limit, cursor.get_insights
What this period did against the one before it.number
The window. The previous window of the same length is the comparison.
string[]
Narrow to specific team members.
search_people with days and min_fit to get the people behind the numbers.
Everything in the answer
Everything in the answer
Breakdowns by format, hook, CTA, media and visual type. Audience by country, seniority,
follower band, industry and company size. Plus top companies, posting cadence and
per-team-member results.No daily series. This is the summary, not the chart data.
Lists and sources
list_audiences
The audiences of this workspace, and their names.number
Page size.
string
The
next_cursor from the previous page.search_people with audience to see who is in one.
What is left out
What is left out
Archived audiences are not listed. The counts are the state of the last scoring round, not
of this second.
radar
List what you track, and add, pause or resume a source.string
required
list, add, pause or resume.string
On
add: person, company or keyword.string
The name of the source. Also accepted by
pause and resume.string
team, competitor, influencer or market.string
An id instead of a display name, on
pause and resume.sources for list, or the single source that was touched.
Use next search_people to see who a source brought in. refresh_data with
kind: refresh_source to fetch new posts for one.
All parameters and the scope rule
All parameters and the scope rule
list takes status and limit. add takes type with the matching person_id,
company_id or keyword_query, plus display_name, source_kind and an optional
label. pause and resume take a source_id or a display_name.The tool itself is read, because listing is reading. The three write actions check their
own scope and refuse with a readable message on a read-only key.Changing things
update_person
Set stage, notes, tags and audience membership, on up to 200 people at once.string[]
required
Always a list, even for one person.
string
lead, customer, peer, watchlist, disqualified, or null to clear.string
null clears the notes.string[]
Replaces the whole list.
string[]
Audience names.
string[]
Audience names.
log_outreach if you also actually sent something.
Unknown ids
Unknown ids
An unknown id is not an error. The rest is updated and the unknown ids come back in the
answer.
log_outreach
Record that you reached out to someone.string
required
Who you contacted.
string
required
linkedin_message, email, call or other.string
What you sent.
string
Defaults to now. Pass it only when backfilling.
string[]
Added to the existing tags, never replacing them.
replayed when this is the stored answer to an
identical earlier call.
Use next search_people with max_outreach_count: 0 to find the next untouched person.
refresh_data
Queue background work, and poll where a run stands.string
refresh_source, enrich or rescore.string
Required by
refresh_source.string
Scopes the work to an audience. Needs
confirm.boolean
Agreement to spend credits on a whole audience.
string
An https URL called when the run finishes, instead of polling.
string
Pass alone to ask where an earlier run stands.
run, or needs_confirmation with people_count and a message.
Use next call again with the run_id to poll. Wait seconds between polls, not
milliseconds.