contacts

Get And Enrich Contact

Changed on

Load a contact and complete whatever it is missing with a provider.

Values already stored in the workspace always win. A person the workspace does not hold yet is saved as a contact, and a found email is saved on the contact. A provider is only called when the match is missing an email, a job title, or a company domain — or when nothing matches but the email or LinkedIn URL given is enough to enrich from scratch — so this can spend enrichment credits. Use GET /v1/contacts/{contact_id} for a free, read-only load.

Requires the contacts:write scope on the API key.

post/v1/contacts/get-and-enrich

Request

  • Base URL: https://api.topo.io
  • URL: https://api.topo.io/v1/contacts/get-and-enrich
  • Auth: HTTP bearer

Request body

contact_idstring uuid nullable

Contact to load, if you have its id.

emailstring nullable

Load the contact by email instead.

linkedin_urlstring nullable

Load the contact by LinkedIn profile URL instead.

Response

Successful Response

foundboolean required

Whether a contact matching the input exists in the workspace.

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

Matched contact in this workspace.

account_idstring uuid nullable

Account the matched contact belongs to.

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.

citystring nullable

City.

countrystring nullable

Country.

enrichedboolean required

Whether email, job title, and company domain are all known.

active_sequence_countinteger required

Sequences the contact is currently enrolled in.

active_sequence_namesstring[] required

Names of the sequence templates currently running.

Changes