Skip to content
/
Single work email lookup...

Single work email lookup result

Request

Return the current state of a work email lookup. status describes the job (queued, running, awaiting_provider, completed, failed) and result describes the outcome once it is terminal (found or not_found). While the job is not terminal a Retry-After header suggests when to poll again. Polling never consumes credits.

Security
Api-Key
Path
account_idintegerrequired
job_idstring, (uuid)required
curl -i -X GET \
  'https://api-v2.forager.ai/api/v2/{account_id}/datastorage/person_contacts_lookup/work_emails/{job_id}/' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
job_idstring, (uuid)read-onlyrequired
statusstring(Status564Enum)read-onlyrequired
  • queued - Queued
  • running - Running
  • awaiting_provider - Awaiting provider
  • completed - Completed
  • failed - Failed
Enum:"queued""running""awaiting_provider""completed""failed"
emailsArray of strings, = 2 charactersread-onlyrequired

Every confirmed address for this person, shortest first, each with its verdict.

error_code(ErrorCodeEnum (string or null)) or (NullEnum (any or null))read-onlyrequired
One of:
  • person_not_found - No person matched the LinkedIn identifier
  • no_current_employer - The person has no current employer on record
  • input_unresolved - Submitted input could not be resolved
  • provider_error - Provider error
  • expired - Expired before completion
  • internal_error - Internal error
string or null(ErrorCodeEnum)read-only
Enum:"person_not_found""no_current_employer""input_unresolved""provider_error""expired""internal_error"
person_idinteger or nullread-onlyrequired
submitted_lookupobjectread-onlyrequired

Echo the row exactly as it was sent.

Nested rather than four top-level fields, so "what you sent" is never confused with "what we searched", and so the top level keeps its rule that an absent value is null - here a blank string is the honest echo.

Spelled out key by key rather than dumped from the stored model, so a new column on SubmittedFields becomes a deliberate addition here instead of appearing in the response unasked.

date_createdstring, (date-time)read-onlyrequired
date_completedstring or null, (date-time)read-onlyrequired
resultstringread-onlyrequired
Response
{
  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",
  "status": "queued",
  "emails": [
    "string"
  ],
  "error_code": "person_not_found",
  "person_id": 0,
  "submitted_lookup": {
    "first_name": "string",
    "last_name": "string",
    "domain": "string",
    "linkedin_public_identifier": "string"
  },
  "date_created": "2019-08-24T14:15:22Z",
  "date_completed": "2019-08-24T14:15:22Z",
  "result": "string"
}