Bulk work email lookup

Request

Submit many work email lookups in one request. Items already answered by our cache are resolved immediately at no vendor cost and reported as resolved_from_cache; duplicates within the request collapse into a single lookup. Your credit balance must cover the whole batch, otherwise the batch is rejected and nothing is charged. Poll the batch for progress and its items endpoint for per-lookup results.

Security

Api-Key

Path

account_idintegerrequired

Body

required

email_lookupsArray of objects, non-empty(WorkEmailLookupRequest)required

webhook_urlstring, <= 2048 characters

Optional https URL we POST the results to when the batch completes, so you need not poll. Put any secret used to authenticate the callback in the URL query string; it is never returned by the poll endpoints or written to logs. Omit to poll only.

Default:""

curl -i -X POST \
  'https://api-v2.forager.ai/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "email_lookups": [
      {
        "first_name": "",
        "last_name": "",
        "domain": "",
        "linkedin_public_identifier": ""
      }
    ],
    "webhook_url": ""
  }'

Responses

Bodyapplication/json

batch_idstring, (uuid)read-onlyrequired

statusstringread-onlyrequired

item_countintegerread-onlyrequired

date_createdstring, (date-time)read-onlyrequired

date_completedstring or null, (date-time)read-onlyrequired

status_check_urlstringread-onlyrequired

webhook_urlstringread-onlyrequired

resultsArray of objects(WorkEmailBatchItem)read-onlyrequired

Response

{
  "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20",
  "status": "string",
  "item_count": 0,
  "date_created": "2019-08-24T14:15:22Z",
  "date_completed": "2019-08-24T14:15:22Z",
  "status_check_url": "string",
  "webhook_url": "string",
  "results": [
    { … }
  ]
}