Use the Company lookup endpoint to build a list of company names along with company ID, city, state and country using rich filters.
The elements in the companies list contain a newid value and enough additional information such that a user could narrow down a selection from the list. Using the selected newid values you can retrieve additional company information through the Target API's New Company Details endpoint.
Endpoint
POST https://api.insideview.com/api/v1/target/company/lookup
Request
HTTP Headers
Header Name | Type | Required | Description |
accessToken | String | Yes | Valid access token. See Authentication and Authorization Overview for more details. |
Accept | String | No |
Selects the response's content type. Use below mentioned values to access New News Platform based search application/api.news.target.company.lookup.beta+json application/api.news.target.company.lookup.beta+xml |
Accept-Language | String | No | Select the response's language and locale. Default value: en-en See Internationalization Support for more details. |
Form Parameters
pageIntegerNoDefault: 1
Parameter Name | Type | Required | Description | ||||||||||||||||
agents | String | No | agents ID. See API Reference data for a list of IDs. |
||||||||||||||||
areaCodes | Integer | No | A comma separated list of area codes | ||||||||||||||||
businessTypes | String | No | A comma separated list of business types. Valid values are: public, private, school,government, organization |
||||||||||||||||
cities | String | No | A comma separated list of cities | ||||||||||||||||
companyStatus | String | No | A comma separated list of status. Valid values are: operating, subsidiary, acquired |
||||||||||||||||
countries | Integer | No | One country ID. See API Reference data for a list of IDs. |
||||||||||||||||
fiscalYearEnd | String | No | Example: january | ||||||||||||||||
fortuneRanking | String | No | Valid values are: fortune500, fortune1000 | ||||||||||||||||
industries | String | No | A comma separated list of industries IDs. See API Reference data for a list of IDs. |
||||||||||||||||
keywords | String | No | |||||||||||||||||
companyName | String | No | Name of the company | ||||||||||||||||
maxEmployees | Integer | No | |||||||||||||||||
maxRevenue | Integer | No | maximum revenue (Millions of $) | ||||||||||||||||
minEmployees | Integer | No | the minimum number of employees. | ||||||||||||||||
minRevenue | Integer | No | minimum revenue (Millions of $) | ||||||||||||||||
categoryIds | Integer | No | Comma-separated list of category ids | ||||||||||||||||
subCategoryIds | Integer | No | Comma-separated list of sub category ids | ||||||||||||||||
productIds | Integer | No | Comma-separated list of product ids | ||||||||||||||||
hasPhone | Boolean | No | Pass it as 'true' to view companies with a phone number. Pass it as 'false', to view all companies including those which have no phone numbers. | ||||||||||||||||
naics | String | No |
A comma separated list of NAICS codes. You can enter NAICS & SIC codes in two different ways:
|
||||||||||||||||
newsDuration | Integer | No | A duration in days (1-30). Works with agents parameter. | ||||||||||||||||
primaryIndustryOnly | String | No | |||||||||||||||||
primaryNAICSOnly | String | No | |||||||||||||||||
primarySICOnly | String | No | |||||||||||||||||
regions | String | No | A comma separated list of regions. Valid values are: Africa, Asia, Europe, MiddleEast, NorthAmerica, Oceania, SouthAmerica |
||||||||||||||||
sic | String | No | |||||||||||||||||
street | String | No | Street name | ||||||||||||||||
state | String | No | Comma separated list of states | ||||||||||||||||
subIndustries | String | No | A comma separated list of sub-industries IDs. See API Reference data for a list of IDs. |
||||||||||||||||
zipCodes | String | No | A comma separated list of zip codes. | ||||||||||||||||
resultsPerPage | Integer | No | Default: 10, maximum value: 500 | ||||||||||||||||
sortBy | String | No | Attributes used to sort the list of results. Valid values are: popularity, revenue, employee_count, businessType, location | ||||||||||||||||
sortOrder | String | No | Valid values are asc, desc | ||||||||||||||||
gender | String | No | Diversity status based on Gender ( "male", "female") | ||||||||||||||||
ethnicity | Int | No |
Diversity status based on Ethnicity. Valid values are comma separated list of ethnicity ids.
|
||||||||||||||||
dbe | Boolean | No | Diversity status based on Disadvantages Business Ent. | ||||||||||||||||
wbe | Boolean | No | Diversity status based on Women Business Ent. | ||||||||||||||||
mbe | Boolean | No | Diversity status based on Minority Business Ent. | ||||||||||||||||
vbe | Boolean | No | Diversity status based on Veteran Business Ent. | ||||||||||||||||
disabled | Boolean | No | Diversity status based on Disabled Business Ent. | ||||||||||||||||
lgbt | Boolean | No | Diversity status based on Gay Lesbian business Ent. |
Responses
Here are the major responses the API may return.
for details on the errors, please refer to the API Error Codes article.
HTTP 200
Returns either a JSON or XML data structure depending on the request Accept header.
Name | type | Description |
companies | Array | Array of search results |
companies> name | String | |
companies > country | String | |
companies > companyType | String | |
companies > id | String | New company id. To be used with the New Company Details endpoint. |
companies > city | String | |
companies > state | String | |
page | Integer | Page number in the result set |
resultsPerPage | Integer | Number of search result per page |
totalResults | Integer | Total number of search results |
application/json Example
{ "companies": [ { "country": "United States", "companyType": "Public", "id": "xA6BNZPztenSEsPIC5z5CWJzT1lxWDSqHMiQcdEtEV0RXFk6wW_4CsnagoE7v-So", "city": "Redmond", "name": "Microsoft Corporation" }, { "country": "United States", "companyType": "Public", "id": "xA6BNZPztenSEsPIC5z5CQsolUy-BvDgv8LFj0CguKwYpiFCYCW_zA3ADNCjvGiA", "city": "Palo Alto", "state": "CA", "name": "jal" }, { "country": "United States", "companyType": "Public", "id": "544KN90XokCKSBrKF8FkXyMHadZtrZeN_RNMHQN4RH2GAssErlMCTgex4fChKOCs", "city": "New York", "state": "NY", "name": "jal" }, { "country": "United States", "companyType": "Public", "id": "xA6BNZPztenSEsPIC5z5CWbSSngPgwVFQaS_xIFzcidFRj654SH-jJtcQsa4JEMx", "city": "Stamford", "state": "CT", "name": "jal" }, { "country": "United States", "companyType": "Private", "id": "NARi-O8bFmNgeOopr2cauoIr1s1SDMUEzN5QNoGOZM8mSXLljXs4hSpkwTPy-fGb", "city": "Santa Clara", "state": "CA", "name": "Avaya Inc." }, { "country": "United States", "companyType": "Public", "id": "xA6BNZPztenSEsPIC5z5CXIEGj4kQiQPN7najTHApEPNX2_fMTQ6-8anEffcMcMm", "city": "Armonk", "state": "NY", "name": "jal" }, { "country": "United States", "companyType": "Public", "id": "xA6BNZPztenSEsPIC5z5CUBXQ2FnKCE2O0xdLEb9OwXyP-U9ySlHRRp5CYdT9nBc", "city": "San Jose", "state": "CA", "name": "jal" }, { "country": "Singapore", "companyType": "Private", "id": "xA6BNZPztenSEsPIC5z5CeyvGtRVB51rGgcoxoLinYgpBr1f4gPXPm-ky_zrD7VJ", "city": "Singapore", "name": "United Test and Assembly Center Ltd." }, { "country": "United States", "companyType": "Public", "id": "xA6BNZPztenSEsPIC5z5CTtjMbCJXKYYlIkGVK_uh-YnDPSU_xCT3m69VUuBhhMa", "city": "Fairfield", "state": "CT", "name": "jal" }, { "country": "United States", "companyType": "Public", "id": "544KN90XokCKSBrKF8FkXxS_LZNylp7GUlLlsdxS6XEcjP4O-TdOAX081_LauNMB", "city": "Charlotte", "state": "NC", "name": "jal" } ], "totalResults": "499", "page": "1", "resultsPerPage": "10" }
application/xml Example
<?xml version="1.0" encoding="UTF-8"?> <companyList>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>xA6BNZPztenSEsPIC5z5CWJzT1lxWDSqHMiQcdEtEV0RXFk6wW_4CsnagoE7v-So</id>
<city>Redmond</city>
<state></state>
<name>Microsoft Corporation</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>xA6BNZPztenSEsPIC5z5CQsolUy-BvDgv8LFj0CguKwYpiFCYCW_zA3ADNCjvGiA</id>
<city>Palo Alto</city>
<state>CA</state>
<name>jal</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>544KN90XokCKSBrKF8FkXyMHadZtrZeN_RNMHQN4RH2GAssErlMCTgex4fChKOCs</id>
<city>New York</city>
<state>NY</state>
<name>jal</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>xA6BNZPztenSEsPIC5z5CWbSSngPgwVFQaS_xIFzcidFRj654SH-jJtcQsa4JEMx</id>
<city>Stamford</city>
<state>CT</state>
<name>jal</name>
</companies>
<companies>
<country>United States</country>
<companyType>Private</companyType>
<id>NARi-O8bFmNgeOopr2cauoIr1s1SDMUEzN5QNoGOZM8mSXLljXs4hSpkwTPy-fGb</id>
<city>Santa Clara</city>
<state>CA</state>
<name>Avaya Inc.</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>xA6BNZPztenSEsPIC5z5CXIEGj4kQiQPN7najTHApEPNX2_fMTQ6-8anEffcMcMm</id>
<city>Armonk</city>
<state>NY</state>
<name>jal</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>xA6BNZPztenSEsPIC5z5CUBXQ2FnKCE2O0xdLEb9OwXyP-U9ySlHRRp5CYdT9nBc</id>
<city>San Jose</city>
<state>CA</state>
<name>jal</name>
</companies>
<companies>
<country>Singapore</country>
<companyType>Private</companyType>
<id>xA6BNZPztenSEsPIC5z5CeyvGtRVB51rGgcoxoLinYgpBr1f4gPXPm-ky_zrD7VJ</id>
<city>Singapore</city>
<name>United Test and Assembly Center Ltd.</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>xA6BNZPztenSEsPIC5z5CTtjMbCJXKYYlIkGVK_uh-YnDPSU_xCT3m69VUuBhhMa</id>
<city>Fairfield</city>
<state>CT</state>
<name>jal</name>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<id>544KN90XokCKSBrKF8FkXxS_LZNylp7GUlLlsdxS6XEcjP4O-TdOAX081_LauNMB</id>
<city>Charlotte</city>
<state>NC</state>
<name>jal</name>
</companies>
<page>1</page>
<totalResults>499</totalResults>
</companyList>
HTTP 400
Invalid query parameter(s).
HTTP 401
Unauthorized Error - Cannot use API's without setting a valid accessToken in header.
HTTP 405
Method Not Allowed - Your are not allowed to access this API.
HTTP 429
Request is throttled.
Comments
0 comments
Please sign in to leave a comment.