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. | ||||||||||||||||
businessStructure |
String |
No |
The organizational structure of a company (globalParent, uncategorized, subsidiary, group, independent) |
||||||||||||||||
companyStatusV2 |
String |
No |
Company status (operating, non-Operating, acquired, liquidating, outOfBusiness, unassigned) |
||||||||||||||||
companyTypeV2 |
String |
No |
Company type (public, private, government, organization, unknown) |
Responses
Here are the major responses the API may return.
For details on the errors, see API Error Codes.
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 |
businessStructure |
String |
The organizational structure of a company (globalParent, uncategorized, subsidiary, group, independent) |
companyStatusV2 |
String |
Company status (operating, non-Operating, acquired, liquidating, outOfBusiness, unassigned) |
companyTypeV2 |
String |
Company type (public, private, government, organization, unknown) |
siteCount |
String |
Number of company sites |
siteLocationCount |
String |
Number of company sites that has site related information |
siteTypes |
String |
Type of a site |
Type: application/json
Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"id": "/",
"type": "object",
"properties": {
"companies": {
"id": "companies",
"type": "array",
"items": [
{
"id": "0",
"type": "object",
"properties": {
"id": {
"id": "id",
"type": "string"
},
"companyId": {
"id": "id",
"type": "string"
},
"name": {
"id": "name",
"type": "string"
},
"city": {
"id": "city",
"type": "string"
},
"state": {
"id": "state",
"type": "string"
},
"country": {
"id": "country",
"type": "string"
},
"companyType": {
"id": "companyType",
"type": "string"
},
"companyStatusV2":{
"id":"companyStatusV2",
"type":"string"
},
"companyTypeV2":{
"id":"companyTypeV2",
"type":"string"
},
"businessStructure":{
"id":"businessStructure",
"type":"string"
}
}
}
]
},
"page": {
"id": "page",
"type": "integer"
},
"resultsPerPage": {
"id": "resultsPerPage",
"type": "integer"
},
"totalResults": {
"id": "totalResults",
"type": "integer"
}
}
}
Example
{
"companies": [
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "-uLXDgZJHqhq66g_A-bpWtZYQHi4uu306k9fctEA7CPdv6tolobz05lwiHRwYLX_",
"city": "Redmond",
"companyStatusV2": "Operating",
"state": "WA",
"name": "Microsoft Corporation",
"companyId": "726263",
"siteCount": 288,
"siteLocationCount": 82,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "-uLXDgZJHqhq66g_A-bpWilOnhkihLNDQARwMWUo2mt8pcRSny75s7YFte6kJCJt",
"city": "Palo Alto",
"companyStatusV2": "Operating",
"state": "CA",
"name": "HP Inc",
"companyId": "725771",
"siteCount": 113,
"siteLocationCount": 166,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "-uLXDgZJHqhq66g_A-bpWsbLdPU5-PAyMBR125K9hDWJ68gfc2hc1YSLw-4m6Kka",
"city": "San Jose",
"companyStatusV2": "Operating",
"state": "CA",
"name": "Cisco Systems, Inc.",
"companyId": "724950",
"siteCount": 274,
"siteLocationCount": 272,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "-uLXDgZJHqhq66g_A-bpWl-1Q848_uO4Qh86RsklqbCfKV73m2RnYFZUA6VPm70y",
"city": "Boston",
"companyStatusV2": "Operating",
"state": "MA",
"name": "General Electric Company",
"companyId": "725565",
"siteCount": 459,
"siteLocationCount": 166,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "-uLXDgZJHqhq66g_A-bpWqc5QiLEuwMcT9goJP8hahK_hFnQGoJ_mfFPtE5FCkwp",
"city": "Dallas",
"companyStatusV2": "Operating",
"state": "TX",
"name": "AT&T Inc.",
"companyId": "727073",
"siteCount": 2200,
"siteLocationCount": 92,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "UR376RAi8hUWKwt5LwU-JVQ5UGZZzaE9Nx1arAXvuuJTaM3_Nzq4u-HwE0b-5M7Z",
"city": "Newton",
"companyStatusV2": "Operating",
"state": "MA",
"name": "Diversified Healthcare Trust",
"companyId": "732433",
"siteLocationCount": 1,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "UR376RAi8hUWKwt5LwU-JTAd-nW88IGmyxsWIHHpFoNT0ul6oamjVtnhplfbawn-",
"city": "CHARLOTTE",
"companyStatusV2": "Operating",
"state": "NC",
"name": "Bank of America Corporation",
"companyId": "731713",
"siteCount": 4604,
"siteLocationCount": 4368,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "UR376RAi8hUWKwt5LwU-JcduiqSR2bh4cy2RZt6r61OLsm3-yDaElcohnX94lA-S",
"city": "Bethesda",
"companyStatusV2": "Operating",
"state": "MD",
"name": "Marriott International, Inc.",
"companyId": "731229",
"siteCount": 80,
"siteLocationCount": 3557,
"siteTypes": [
"Uncategorized"
]
},
{
"country": "Ireland",
"companyType": "Public",
"companyTypeV2": "Public",
"businessStructure": "globalParent",
"id": "UR376RAi8hUWKwt5LwU-JagZLl3jueWmElSIOqWrFI1yP022wi1bb5L20o33VhK3",
"city": "Dublin",
"companyStatusV2": "Operating",
"name": "Accenture Plc",
"companyId": "733739",
"siteTypes": [
"Uncategorized"
]
},
{
"country": "United States",
"companyType": "Public",
"companyTypeV2": "Private",
"businessStructure": "Subsidiary",
"id": "UR376RAi8hUWKwt5LwU-JSAj8j0sCmzW7YObi9EyRIlp6d6APzBcqX2v1aIE0kqI",
"city": "MOUNTAIN VIEW",
"companyStatusV2": "Operating",
"state": "CA",
"name": "Alphabet Inc",
"companyId": "736233",
"siteCount": 77
}
],
"totalResults": "14558371",
"page": "1",
"resultsPerPage": "10"
}
Type: application/xml
Schema
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"> <xs:element name="companyList"> <xs:complexType> <xs:sequence> <xs:element name="company" minOccurs="0" maxOccurs="unbounded"> <xs:complexType> <xs:sequence> <xs:element name="city" type="xs:string" minOccurs="0"/> <xs:element name="companyType" type="xs:string" minOccurs="0"/> <xs:element name="id" type="xs:string" minOccurs="1"/> <xs:element name="companyId" type="xs:string" minOccurs="1"/> <xs:element name="country" type="xs:string" minOccurs="0"/> <xs:element name="name" type="xs:string" minOccurs="0"/> <xs:element name="state" type="xs:string" minOccurs="0"/> <xs:element name="companyStatus" type="xs:string" minOccurs="0"/> <xs:element name="companyStatusV2" type="xs:string" minOccurs="0"/> <xs:element name="companyTypeV2" type="xs:string" minOccurs="0"/> <xs:element name="businessStructure" type="xs:string" minOccurs="0"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="page" type="xs:int"/> <xs:element name="resultsPerPage" type="xs:int"/> <xs:element name="totalResults" type="xs:int"/> </xs:sequence> </xs:complexType> </xs:element> </xs:schema>
Example
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<companyList>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>-uLXDgZJHqhq66g_A-bpWtZYQHi4uu306k9fctEA7CPdv6tolobz05lwiHRwYLX_</id>
<city>Redmond</city>
<companyStatusV2>Operating</companyStatusV2>
<state>WA</state>
<name>Microsoft Corporation</name>
<companyId>726263</companyId>
<siteCount>288</siteCount>
<siteLocationCount>82</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>-uLXDgZJHqhq66g_A-bpWilOnhkihLNDQARwMWUo2mt8pcRSny75s7YFte6kJCJt</id>
<city>Palo Alto</city>
<companyStatusV2>Operating</companyStatusV2>
<state>CA</state>
<name>HP Inc</name>
<companyId>725771</companyId>
<siteCount>113</siteCount>
<siteLocationCount>166</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>-uLXDgZJHqhq66g_A-bpWsbLdPU5-PAyMBR125K9hDWJ68gfc2hc1YSLw-4m6Kka</id>
<city>San Jose</city>
<companyStatusV2>Operating</companyStatusV2>
<state>CA</state>
<name>Cisco Systems, Inc.</name>
<companyId>724950</companyId>
<siteCount>274</siteCount>
<siteLocationCount>272</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>-uLXDgZJHqhq66g_A-bpWl-1Q848_uO4Qh86RsklqbCfKV73m2RnYFZUA6VPm70y</id>
<city>Boston</city>
<companyStatusV2>Operating</companyStatusV2>
<state>MA</state>
<name>General Electric Company</name>
<companyId>725565</companyId>
<siteCount>459</siteCount>
<siteLocationCount>166</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>-uLXDgZJHqhq66g_A-bpWqc5QiLEuwMcT9goJP8hahK_hFnQGoJ_mfFPtE5FCkwp</id>
<city>Dallas</city>
<companyStatusV2>Operating</companyStatusV2>
<state>TX</state>
<name>AT&T Inc.</name>
<companyId>727073</companyId>
<siteCount>2200</siteCount>
<siteLocationCount>92</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>UR376RAi8hUWKwt5LwU-JVQ5UGZZzaE9Nx1arAXvuuJTaM3_Nzq4u-HwE0b-5M7Z</id>
<city>Newton</city>
<companyStatusV2>Operating</companyStatusV2>
<state>MA</state>
<name>Diversified Healthcare Trust</name>
<companyId>732433</companyId>
<siteLocationCount>1</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>UR376RAi8hUWKwt5LwU-JTAd-nW88IGmyxsWIHHpFoNT0ul6oamjVtnhplfbawn-</id>
<city>CHARLOTTE</city>
<companyStatusV2>Operating</companyStatusV2>
<state>NC</state>
<name>Bank of America Corporation</name>
<companyId>731713</companyId>
<siteCount>4604</siteCount>
<siteLocationCount>4368</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>UR376RAi8hUWKwt5LwU-JcduiqSR2bh4cy2RZt6r61OLsm3-yDaElcohnX94lA-S</id>
<city>Bethesda</city>
<companyStatusV2>Operating</companyStatusV2>
<state>MD</state>
<name>Marriott International, Inc.</name>
<companyId>731229</companyId>
<siteCount>80</siteCount>
<siteLocationCount>3557</siteLocationCount>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>Ireland</country>
<companyType>Public</companyType>
<companyTypeV2>Public</companyTypeV2>
<businessStructure>globalParent</businessStructure>
<id>UR376RAi8hUWKwt5LwU-JagZLl3jueWmElSIOqWrFI1yP022wi1bb5L20o33VhK3</id>
<city>Dublin</city>
<companyStatusV2>Operating</companyStatusV2>
<name>Accenture Plc</name>
<companyId>733739</companyId>
<siteTypes>Uncategorized</siteTypes>
</companies>
<companies>
<country>United States</country>
<companyType>Public</companyType>
<companyTypeV2>Private</companyTypeV2>
<businessStructure>Subsidiary</businessStructure>
<id>UR376RAi8hUWKwt5LwU-JSAj8j0sCmzW7YObi9EyRIlp6d6APzBcqX2v1aIE0kqI</id>
<city>MOUNTAIN VIEW</city>
<companyStatusV2>Operating</companyStatusV2>
<state>CA</state>
<name>Alphabet Inc</name>
<companyId>736233</companyId>
<siteCount>77</siteCount>
</companies>
<page>1</page>
<totalResults>14558371</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.