Queues a work email and/or mobile phone lookup for each of the given leads (leadIds, up to 5000) or every lead of a list (listId) and returns at once. A lead is skipped when it already has the value, was looked up before with nothing found, or has nothing to look it up by (a phone needs a LinkedIn profile; an email needs one, or a first name, last name and company). Lookups run in the background, usually within minutes: each result lands on the lead (email / phone, and enrichment.<kind>.status) and fires lead.enriched. Charged per result found, 8 credits per email and 100 per phone; nothing for a miss. Out of credits is a 400 with code: warning-no-credits when asking, and a lookup reached after the credits ran out ends failed with reason: no_credits.
Authorization
bearerAuth An API key created on the Access tokens page.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/leads/enrich" \ -H "Content-Type: application/json" \ -d '{ "listId": "Hq8vX2kPa3nZbQe7m", "email": true, "phone": false }'{ "data": { "total": 240, "queued": { "email": 212 } }}Find a lead's email or phone POST
Looks up the lead's work email (by default) and/or mobile phone now and returns the lead with what was found saved on it. A value the lead already has is kept, and not charged or looked up again. A hit usually answers in a couple of seconds; a miss only once every source was tried, which can take up to a minute. Charged per result found, 8 credits per email and 100 per phone; nothing for a miss. `enrichment.<kind>.status` says how each lookup ended. A lookup already running on this lead is a 409 with `code: lookup_running`.
Get a lead GET
Next Page