Retrieve enrichment information for a company

Updated:

GET/enrich/{connection_id}/company

Parameters

domainstring
The domain of the company to search
namestring
The name of the company to search
connection_idstring required
ID of the connection

Returns

Response fieldTypeRequiredDescription
idstringNoUnique identifier for this company object
created_atstring (date-time)NoThe date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoThe name of the company
descriptionstringNoThe description of the company
domainstringNoThe webmail domain of the company
twitter_handlestringNoThe twitter handle of the company
twitter_urlstringNoThe twitter URL of the company
addressobjectNoThe address of the company
address.address1stringNo
address.address2stringNo
address.citystringNo
address.regionstringNo
address.region_codestringNo
address.postal_codestringNo
address.countrystringNo
address.country_codestringNo
telephonesEnrichTelephone[]NoAn array of telephones for this company
telephones[].telephonestringYes
telephones[].typeenumNoValues: WORK, HOME, OTHER, FAX, MOBILE
linkedin_urlstringNoThe LinkedIn URL of the company
crunchbase_urlstringNoThe Crunchbase URL of the company
facebook_urlstringNoThe Facebook URL of the company
youtube_urlstringNoThe Youtube URL of the company
instagram_urlstringNoThe Crunchbase URL of the company
yelp_urlstringNoThe Yelp URL of the company
logo_urlstringNoThe URL of the logo of the company
exchangestringNoThe public exchange of the company (eg. NASDAQ)
stockstringNoThe stock ticker of the company (eg. AMZN)
year_foundednumberNoThe year that the company was founded
alexa_ranknumberNoThe Alexa rank of the company
naics_codenumberNoThe NAICS code of the company
sic_codenumberNoThe SIC code of the company
employeesstringNoThe number of employees at the company
revenuestringNoThe approximate revenue of the company
industrystringNoThe industry of the company

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/company',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    domain: '',
    name: '',
  }
};

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