Sign in
Contacts

Lookup Contact

get/api/v1/contacts/lookup

Query parameters

emailstring nullable
email_containsstring nullable

Substring match on stored email value (case-insensitive).

Substring match on stored email value (case-insensitive).

email_domainstring nullable

Suffix match on '@<domain>'. Leading '@' is tolerated.

Suffix match on '@<domain>'. Leading '@' is tolerated.

phonestring nullable
phone_containsstring nullable

Substring match on stored E.164 phone value.

Substring match on stored E.164 phone value.

Response

Successful Response

idstring uuid required
organization_idstring required
preferred_namestring nullable required
name_prefixstring nullable required
given_namestring nullable required
middle_namestring nullable required
family_namestring nullable required
name_suffixstring nullable required
company_namestring nullable required
job_titlestring nullable required
birthdaystring date nullable required
notesstring nullable required
creation_source'manual' | 'vcard' | 'communication' | 'backfill' required
review_status'unreviewed' | 'confirmed' required
reviewed_atstring date-time nullable required
reviewed_bystring nullable required
preferred_name_source'manual' | 'vcard' | 'provider' | 'mail_header' | 'identifier_fallback' required
preferred_name_locked_atstring date-time nullable required
created_by_identity_idstring uuid nullable required
merged_into_contact_idstring uuid nullable required
is_auto_createdboolean required
is_confirmedboolean required
status'active' | 'paused' | 'deleted' required
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this endpoint across all 1 revision of this API.