Retrieve enrichment information for a person

Updated:

GET/enrich/{connection_id}/person

Parameters

emailstring
The email of the person to search
twitterstring
The twitter handle of the person to search
namestring
The name of the person to search
linkedin_urlstring
The LinkedIn URL of the person to search
company_namestring
The name of the company the person is associated with. Not valid by itself.
connection_idstring required
ID of the connection

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for this person object
created_atstring (date-time)NoThe date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the person
first_namestringNo
last_namestringNo
titlestringNoThe job title of the person
birthdatestringNoThe birth date of the person
image_urlstringNoThe image URL of the person
biostringNoThe biography description of the person
companystringNoThe company/organization name of the person
company_domainstringNoThe company's domain
emailsEnrichEmail[]NoAn array of email addresses for this person
emails[].emailstringYes
emails[].typeenumNoValues: WORK, HOME, OTHER
emails[].is_verifiedbooleanNo
telephonesEnrichTelephone[]NoAn array of telephones for this person
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
twitter_handlestringNoThe twitter handle of the person
linkedin_urlstringNoThe LinkedIn URL of the person
github_urlstringNoThe GitHub URL of the person
github_usernamestringNoThe GitHub username of the person
twitter_urlstringNoThe twitter URL of the person
facebook_urlstringNoThe Facebook URL of the person
genderenumNoThe gender of the person Values: MALE, FEMALE
addressobjectNoThe address of the person
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNo
timezonestringNoThe timezone code of the person
utc_offsetnumberNoThe timezone's hourly offset from UTC of the person
work_historiesEnrichPersonWorkHistory[]No
work_histories[].company_idstringNo(reference to EnrichCompany)
work_histories[].company_namestringNo
work_histories[].titlestringYes
work_histories[].start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
work_histories[].end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
work_histories[].locationstringNo
work_histories[].company_domainstringNo

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/enrich/5de520f96e439b002043d8dc/person',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    email: '',
    twitter: '',
    name: '',
    linkedin_url: '',
    company_name: '',
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?