contacts

Get Contact Enrichment

Changed on

Collect the answer of an enrichment that returned completed: false.

Waits up to about 20 seconds for the answer; while it is still running the response is completed: false again, so call back a minute later. The email credit is only spent once the answer is delivered, and collecting it again is free.

Requires the contacts:write scope on the API key.

get/v1/contacts/enrichments/{enrichment_id}

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contacts/enrichments/{enrichment_id}
  • Auth: HTTP bearer

Path parameters

enrichment_idstring uuid required

ID of the enrichment.

Response

Successful Response

completedboolean required

Whether enrichment finished. false while the lookup is still running: collect the answer with enrichment_id.

enrichment_idstring uuid nullable

Set when completed is false: pass it to GET /v1/contacts/enrichments/{enrichment_id} to collect the answer instead of enriching again.

contact_idstring uuid nullable

The workspace contact the answer was saved on.

emailstring nullable

Email.

first_namestring nullable

First name.

last_namestring nullable

Last name.

job_titlestring nullable

Job title.

linkedin_urlstring nullable

LinkedIn profile URL.

phone_numberstring nullable

Phone number.

company_namestring nullable

Employer name.

company_domainstring nullable

Employer's primary domain.

Changes