Leads
The people of your workspace, with their company, work history and pipeline status.
A lead is a person in your workspace. Leads come from the signals you set up, from account mapping at your monitored accounts, from the people lists you fill, and from the Sillage app and Chrome extension. A lead carries their profile, their current company, their work history, where they stand in the pipeline and who owns them.
Endpoints
| Method | Path | Description |
|---|---|---|
| POST | /api/v3/leads/query | Query leads: search the leads of the workspace. |
| POST | /api/v3/leads/count | Count leads: count the leads that match filters. |
| GET | /api/v3/leads/{lead_id} | Get a lead: retrieve one lead. |
| PATCH | /api/v3/leads/{lead_id} | Update a lead: change its pipeline status or owner. |
Filters
Query leads and Count leads take the same filters, all optional: a creation date range (created_at_from and created_at_to, both included), company filters, and location filters (countries and cities). Different filters combine with AND, and several values inside one filter combine with OR.
The four company filters add up: a lead matches when its company is any of the company_ids, domains, LinkedIn handles or LinkedIn URLs you send. A value that matches no company in your workspace matches nothing, so the answer is no result (a count of 0 for Count leads), never an error. Company filters combine with every other filter, and all of those have to match.
Pipeline status
Every lead has a status. New leads start as pending.
| Status | Meaning |
|---|---|
pending | Default status for new leads. |
contacted_email | Contacted by email. |
contacted_phone | Contacted by phone. |
contacted_linkedin | Contacted on LinkedIn. |
meeting_booked | A meeting is booked. |
need_follow_up | Needs a follow-up. |
already_in_touch | Already in contact. |
customer | Became a customer. |
declined | Declined. |
disqualified | Disqualified. |
company_not_icp | The company does not match your ideal customer profile. |
job_title_not_icp | The job title does not match your ideal customer profile. |
Use Update a lead to change a status or the owner.
Location
Every location in this API has the same shape: { "city", "region", "country", "country_code" }. Any part is null when it is not known. country_code is the ISO country code, for example FR.