Retrieve enrichment information for a company
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 field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for this company object |
created_at | string (date-time) | No | The date that this company object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | The last date that this company object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
name | string | No | The name of the company |
description | string | No | The description of the company |
domain | string | No | The webmail domain of the company |
twitter_handle | string | No | The twitter handle of the company |
twitter_url | string | No | The twitter URL of the company |
address | object | No | The address of the company |
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 | |
telephones | EnrichTelephone[] | No | An array of telephones for this company |
telephones[].telephone | string | Yes | |
telephones[].type | enum | No | Values: WORK, HOME, OTHER, FAX, MOBILE |
linkedin_url | string | No | The LinkedIn URL of the company |
crunchbase_url | string | No | The Crunchbase URL of the company |
facebook_url | string | No | The Facebook URL of the company |
youtube_url | string | No | The Youtube URL of the company |
instagram_url | string | No | The Crunchbase URL of the company |
yelp_url | string | No | The Yelp URL of the company |
logo_url | string | No | The URL of the logo of the company |
exchange | string | No | The public exchange of the company (eg. NASDAQ) |
stock | string | No | The stock ticker of the company (eg. AMZN) |
year_founded | number | No | The year that the company was founded |
alexa_rank | number | No | The Alexa rank of the company |
naics_code | number | No | The NAICS code of the company |
sic_code | number | No | The SIC code of the company |
employees | string | No | The number of employees at the company |
revenue | string | No | The approximate revenue of the company |
industry | string | No | The 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"
}| 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/company',
headers: {
authorization: 'bearer .....'
},
params: {
domain: '',
name: '',
}
};
const results = await axios.request(options); Are we missing anything? Let us know
Was this page helpful?