Overview
A lead is a contact record, a person your team is reaching out to. Leads live inside lead lists, which are collections used to organize contacts and enroll them into campaigns. Every lead has:- Core identity fields (
first_name,last_name,email,phone_number,linkedin_url,company) - Enrichment fields (
job_title,company_domain,company_size,location, etc.) - Status fields (
status,pipeline_stage,traffic_light_status,automation_paused) - A full activity timeline (calls, emails, SMS, LinkedIn, WhatsApp messages)
Creating leads
lead_list_id places the lead in the default list. To target a specific list:
Listing and filtering leads
pipeline_stage values: new, contacted, engaged, meeting_booked, meeting_scheduled, proposal_sent, closed_won, closed_lost
Valid status values: active, unsubscribed, bounced, dnc
Results are paginated. Use page and per_page to navigate:
The response envelope includes
total so you can calculate the number of pages: Math.ceil(total / per_page).
Updating pipeline stage
Move a lead forward (or back) in your sales pipeline:Lead pipeline
Every lead moves through a sales pipeline. Stages advance automatically during campaign execution or can be set manually via the API.Enriching a lead
Trigger the enrichment waterfall to fill in missing contact data:Lead activity timeline
Get a full reverse-chronological history of everything that happened with a lead:Lead lists
Organize leads into lists for bulk operations:job_id you can poll via GET /api/v1/public/jobs/{job_id}.
DNC / unsubscribes
Leads withstatus: "dnc" or status: "unsubscribed" are never contacted. You can also manage the DNC list directly, see DNC guide.