Account
me
account.me
Read the user and organization the API key belongs to, with the key’s role
Risk: read
user full type
user full type
Campaigns
create
campaigns.create
Create a campaign in draft from a sequence graph; it contacts nobody until campaigns.update sets it active
Risk: write
graph full type
graph full type
schedule full type
schedule full type
limits full type
limits full type
suppressionPolicy full type
suppressionPolicy full type
campaign full type
campaign full type
delete
campaigns.delete
Archive a campaign: it stops sending and leaves the active list, and the record is kept
Risk: destructive
enroll
campaigns.enroll
Enroll up to 500 leads at once, with one result per lead so a batch can partly succeed; an enrolled lead can be contacted
Risk: destructive · Irreversible
results full type
results full type
get
campaigns.get
Read one campaign, including its sequence graph and status
Risk: read
campaign full type
campaign full type
leads
campaigns.leads
Page through the leads enrolled in a campaign with their status
Risk: read
leads full type
leads full type
list
campaigns.list
Page through campaigns, optionally filtered by status
Risk: read
campaigns full type
campaigns full type
stats
campaigns.stats
Read a campaign’s progress and funnel: invites, messages, replies, and why leads were skipped
Risk: read
stats full type
stats full type
stopLeads
campaigns.stopLeads
Stop leads in a campaign so no further step reaches them, keeping them in the list
Risk: write
results full type
results full type
update
campaigns.update
Rename a campaign, replace its graph, or set active to start sending and paused to halt it; going active begins contact and cannot be undone
Risk: destructive · Irreversible
graph full type
graph full type
schedule full type
schedule full type
limits full type
limits full type
suppressionPolicy full type
suppressionPolicy full type
campaign full type
campaign full type
Compose
preview
compose.preview
Preview an AI-composed message for a lead without sending it, with the context sources it used
Risk: read
meta full type
meta full type
Leads
create
leads.create
Create a lead with a LinkedIn or Instagram identity; a duplicate identity is refused with 409, so use leads.upsert to merge instead
Risk: write
identities full type
identities full type
lead full type
lead full type
delete
leads.delete
Delete a lead and its identities permanently; there is no restore call
Risk: destructive · Irreversible
get
leads.get
Read one lead by id, with its identities and live enrollment
Risk: read
lead full type
lead full type
list
leads.list
Page through the workspace’s leads by cursor
Risk: read
leads full type
leads full type
search
leads.search
Search leads by free text and structured filters, combined with AND, paged by cursor
Risk: read
filters full type
filters full type
leads full type
leads full type
update
leads.update
Patch a lead’s fields by id; sending identities replaces the whole set rather than adding to it
Risk: write
identities full type
identities full type
lead full type
lead full type
upsert
leads.upsert
Create the lead, or patch the fields onto the one an identity already belongs to, reporting created or matched
Risk: write
identities full type
identities full type
lead full type
lead full type
Places
search
places.search
Search places by free text or around a point, returning addresses, coordinates and websites
Risk: read
location full type
location full type
hits full type
hits full type
Suppressions
check
suppressions.check
Check up to 1000 identities against the suppression list and answer contactable with the reason when not
Risk: read
identities full type
identities full type
results full type
results full type
create
suppressions.create
Suppress up to 1000 leads or company domains, with counts for what was created and what was already listed
Risk: write
entries full type
entries full type
delete
suppressions.delete
Remove a suppression entry, which makes that person or domain contactable again
Risk: destructive
list
suppressions.list
Page through suppression entries, optionally filtered by reason
Risk: read
suppressions full type
suppressions full type