enrichment

Find emails

Request email finding. Two input modes (mutually exclusive): (1) personIDs - array of IDs obtained from POST /search, (2) people - array of objects, each with either linkedinURL (e.g. "https://www.linkedin.com/in/john-doe") or firstName + lastName + company name (e.g. "Salesforge", not a URL). Max 500 items. Original input fields are echoed back on each result for correlation. People array entries are deduplicated by normalized linkedinURL or by case-insensitive firstName+lastName+company; only one result is returned per unique person, so duplicate entries (e.g. two CRM records pointing at the same person with different externalIDs) will lose the externalIDs of the duplicates - send unique people if you need each externalID echoed back. Each person in the people array may include an optional externalID (max 128 chars), a pure passthrough value persisted with the result and echoed back in the webhook payload and GET /results response for client-side correlation; externalID is not supported in personIDs mode. Example with people: {"people": [{"linkedinURL": "https://www.linkedin.com/in/john-doe", "externalID": "crm-42"}, {"firstName": "Jane", "lastName": "Smith", "company": "Salesforge"}], "webhookURL": "https://example.com/webhook"}. Example with personIDs: {"personIDs": ["p_abc123", "p_def456"]}. Webhook delivery: 2xx = success; a failed delivery is retried immediately and then redelivered in the background for up to 24h, every attempt carrying the same X-Webhook-Delivery-Id header so repeated deliveries can be deduplicated.

post/enrichment/emails

Request

  • Base URL: https://api.leadsforge.ai
  • URL: https://api.leadsforge.ai/enrichment/emails
  • Auth: ApiKeyAuth (a scheme the document does not define)

Headers

Idempotency-Keystring

Idempotency key

Request body

clientRequestIDstring
personIDsstring[]
saveToListboolean
webhookURLstring

Example request

{
  "clientRequestID": "my-request-123",
  "people": [
    {
      "company": "Salesforge",
      "companyDomain": "salesforge.ai",
      "externalID": "crm-contact-42",
      "firstName": "John",
      "lastName": "Doe",
      "linkedinURL": "https://www.linkedin.com/in/john-doe"
    }
  ],
  "personIDs": [
    "p_abc123",
    "p_def456"
  ],
  "webhookURL": "https://example.com/webhook"
}

Response

Job created

channelstring
clientRequestIDstring
completedAtstring
consumedCreditsnumber
createdAtstring
failedinteger
jobIDstring
processedinteger
reservedCreditsnumber
resultsURLstring
statusstring
statusURLstring
succeededinteger
totalinteger
updatedAtstring
webhookURLstring

Changes

No recorded changes to this operation across all 1 revision of this API.