Skip to main content
GET
/
v1
/
api
/
enrichment
/
email
/
{id}
Poll an email enrichment request
curl --request GET \
  --url https://client-api.salesfinity.co/v1/api/enrichment/email/{id} \
  --header 'x-api-key: <api-key>'
{
  "_id": "507f1f77bcf86cd799439011",
  "linkedin_url": "https://www.linkedin.com/in/username",
  "email": {
    "email": "[email protected]",
    "type": "work"
  },
  "external_id": "lead-42"
}
Returns the current state of an email enrichment request created with Request an Email Enrichment. Polling is the fallback for the callback_url webhook — it is safe to call repeatedly, and a request is never charged twice regardless of how often you poll.

​
Path Parameters

ParameterTypeDescription
idstringThe enrichment request _id returned when the request was created.

​
Status lifecycle

StatusMeaning
pendingAccepted, not yet started.
processingLookup in progress.
completedAn email was found — see the email field. (1 credit charged.)
not-foundLookup finished, no email available. email is null. No credit charged.
failedThe lookup could not be completed.

​
Response (200) — completed

{
  "_id": "507f1f77bcf86cd799439011",
  "status": "completed",
  "enrichment_type": "work_email",
  "email": { "email": "[email protected]", "type": "work" },
  "linkedin_url": "https://www.linkedin.com/in/janedoe",
  "external_id": "lead-42"
}

​
Response (200) — still running

{
  "_id": "507f1f77bcf86cd799439011",
  "status": "processing",
  "linkedin_url": "https://www.linkedin.com/in/janedoe"
}

​
Errors

StatusDescription
404No enrichment request found for the given id

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
id
string
required

The enrichment request _id returned by POST /v1/api/enrichment/email.

Response

Current state of the enrichment request.

​
_id
string

Enrichment request ID. Use this to poll GET /v1/api/enrichment/email/{id}.

Example:

"507f1f77bcf86cd799439011"

​
status
enum<string>

Current state of the request. completed means an email was found; not-found means none was available.

Available options:
pending,
processing,
completed,
not-found,
failed
​
linkedin_url
string
Example:

"https://www.linkedin.com/in/username"

​
enrichment_type
enum<string>

Present once the lookup resolves. Reflects the requested email type.

Available options:
work_email,
personal_email
​
email
object

Populated when status is completed. Null when status is not-found.

​
external_id
string

The external_id supplied on the original request, if any.

Example:

"lead-42"