Retrieve enrichment information for a person
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 field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this person object |
created_at | string (date-time) | No | The date that this person object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this person object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The name of the person |
first_name | string | No | |
last_name | string | No | |
title | string | No | The job title of the person |
birthdate | string | No | The birth date of the person |
image_url | string | No | The image URL of the person |
bio | string | No | The biography description of the person |
company | string | No | The company/organization name of the person |
company_domain | string | No | The company's domain |
emails | EnrichEmail[] | No | An array of email addresses for this person |
emails[].email | string | Yes | |
emails[].type | enum | No | Values: WORK, HOME, OTHER |
emails[].is_verified | boolean | No | |
telephones | EnrichTelephone[] | No | An array of telephones for this person |
telephones[].telephone | string | Yes | |
telephones[].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
twitter_handle | string | No | The twitter handle of the person |
linkedin_url | string | No | The LinkedIn URL of the person |
github_url | string | No | The GitHub URL of the person |
github_username | string | No | The GitHub username of the person |
twitter_url | string | No | The twitter URL of the person |
facebook_url | string | No | The Facebook URL of the person |
gender | enum | No | The gender of the person Values: MALE, FEMALE |
address | object | No | The address of the person |
address.address1 | string | No | |
address.address2 | string | No | |
address.city | string | No | |
address.region | string | No | |
address.region_code | string | No | |
address.postal_code | string | No | |
address.country | string | No | |
address.country_code | string | No | |
timezone | string | No | The timezone code of the person |
utc_offset | number | No | The timezone's hourly offset from UTC of the person |
work_histories | EnrichPersonWorkHistory[] | No | |
work_histories[].company_id | string | No | (reference to EnrichCompany) |
work_histories[].company_name | string | No | |
work_histories[].title | string | Yes | |
work_histories[].start_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
work_histories[].end_at | string (date-time) | No | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
work_histories[].location | string | No | |
work_histories[].company_domain | string | No |
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"
}| Status | Error | Meaning |
|---|---|---|
400 | Bad Request | The request was malformed or failed validation. |
401 | Unauthorized | The connection is likely broken; re-authorize it. |
403 | Forbidden | The connection is missing permissions or scopes. |
404 | Not Found | The requested resource does not exist. |
429 | Too Many Requests | Rate limit exceeded (see the two sources below). |
500 | Internal Server Error | An unexpected error occurred. |
501 | Not Implemented | Not 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?