Skip to main content
GET
Get Contacts Enrich Job

Authorizations

api_key
string
header
required

Your Lusha API key. You can find this in your Lusha dashboard under API settings. Include this key in the api_key header for all requests.

Path Parameters

jobId
string
required

The job.id returned by Enrich Contacts.

Example:

"wf_3f2b9c1e-4a7d-4f3b-9c2e-1d6a5b8c7e90"

Response

Job state

jobId
string
required
Example:

"wf_3f2b9c1e-4a7d-4f3b-9c2e-1d6a5b8c7e90"

status
enum<string>
required

Branch on this.

  • processing - poll again after retryAfter seconds. covers lists what is still open.
  • complete - final. Merge contacts into your enrich results by id.
  • expired - final. The provider did not answer in time. Keep the enrich results.
  • failed - final. reason is set. Keep the enrich results.
Available options:
processing,
complete,
expired,
failed
requestId
string
required

Correlation id of the Enrich Contacts call that started the job.

expiresAt
string<date-time>
required

After this time the job is gone.

retryAfter
number

processing only. Seconds to wait before polling again.

covers
object[]

processing only. What is still outstanding.

contacts
object[]

Final states only. Only the contacts this job covered, each complete. Contacts already returned by Enrich Contacts are not repeated. Merge by id.

creditsCharged
number

Final states only. Credits charged by the async phase only - Enrich Contacts already reported its own charge in billing.creditsCharged.

reason
string

failed only. Why the job failed.