Bulk work email lookup status and results

Request

Return a bulk work email lookup batch. Poll until status is completed, at which point results holds one result per submitted lookup, in the order they were submitted, each with the same shape as a single lookup result. results is empty until then, so a partial answer is never mistaken for a whole one.

Security

Api-Key

Path

account_idintegerrequired

batch_idstring, (uuid)required

curl -i -X GET \
  'https://api-v2.forager.ai/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/bulk/{batch_id}/' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json

batch_idstring, (uuid)read-onlyrequired

statusstring(WorkEmailBatchStatusEnum)read-onlyrequired

queued - Queued
running - Running
completed - Completed
failed - Failed

Enum:"queued""running""completed""failed"

item_countintegerread-onlyrequired

How many rows this batch holds.

date_createdstring, (date-time)read-onlyrequired

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

resultsArray of objects(WorkEmailBatchItem)read-onlyrequired

Response

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