[POST] - Company List

Follow

Use the Target API's Company List endpoint to build a list a companies 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/companies

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.  
Valid values are application/json and application/xml (default).

Use below mentioned values to access New News Platform based search

application/api.news.target.company.beta+json

application/api.news.target.company.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  
minEmployees Integer No  
minRevenue Integer No  
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
naics String No

A comma separated list of NAICS codes.
List of NAICS codes.

You can enter NAICS & SIC codes in two different ways:

  • Direct code – for example, enter 511210 for Software Publishers.
  • Top Level codes – for example, enter 511* for All Publishing Industries which would include 51111 – 51119 or even 5112* which would include 511210.
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
ethnicity Int No

Diversity status based on Ethnicity. Valid values are comma separated list of ethnicity ids. 

ID Values
1 Asian-Indian
2 Non-Ethnic
3 Asian-Pacific
4 Hispanic
5 African American
6 Native American
7 Asian

 

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 > country String  
companies > employees Integer  
companies > fiscalYearEnd String  
companies > industry String  
companies > industryCode String  
companies > subIndustry String  
companies > subIndustryCode String  
companies > revenue String  
companies > revenueCurrency String  
companies > sic Integer  
companies > naics Integer  
companies > companyType String  
companies > id String New company id.  To be used with the New Company Details endpoint.
companies > city  String  
companies > companyStatus String  
companies > naicsDescription String  
companies > sicDescription String  
companies > state String  
companies > subsidiary Boolean  
companies > companyIdMd5 String MD5 hash of the record InsideView company id.  This can be used to compare with contact ids you already know of, to avoid calling the New Company Details endpoint.
companies > britishSics List  List of British SIC Codes
companies > britishSics > britishSic String British SIC code
companies > britishSics > description String  British SIC code description
companies>zip String  
companyFacebookProfile String Facebook profile of Company
companyTwitterProfile String  Twitter profile of Company
companyBlogProfile  String  Blog Url link of Company
companyLinkedInProfile  String LinkedIn profile of Company
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",
      "employees": 750,
      "fiscalYearEnd": "0",
      "industry": "Corporate Services",
      "subIndustry": "Management Consulting",
      "revenue": "43.75",
      "sic": "8742",
      "naics": "541611",
      "companyType": "Private",
      "id": "3Qi2YsBVHeHgnxwhQHdwsmxxBCVh6xKgTcNVU2YEmGcq60UWkbROad4U-Ac3YzqU",
      "city": "Boston",
      "companyStatus": "Operating",
      "naicsDescription": "Administrative Management and General Management Consulting Services",
      "sicDescription": "Services-Management Consulting Services",
      "state": "MA",
      "subsidiary": "Operating",
      "companyIdMd5Hash": "073fafb94b63aeb67e769c0c1269e64c",
      "revenueCurrency": "USD",
      "industryCode": "12",
      "subIndustryCode": "12_19",
      "zip": "02199",
      "name": "Analysis Group, Inc.",
      "britishSics": [
        {
          "britishSic": "70229",
          "description": "Management consultancy activities other than financial management"
        },
        {
          "britishSic": "71122",
          "description": "Engineering related scientific and technical consulting activities"
        }
      ],
      "companyFacebookProfile": "AnalysisGroupConsulting",
      "companyTwitterProfile": "analysisgroup",
      "companyBlogProfile": "whsSQLi",
      "companyLinkedInProfile": "analysis-group"
    },
    {
      "country": "United States",
      "employees": 3066,
      "fiscalYearEnd": "0",
      "industry": "Computer Software",
      "subIndustry": "Development Tools and Utilities Software",
      "revenue": "700.0",
      "sic": "7371",
      "naics": "511210",
      "companyType": "Private",
      "id": "Ff24HpXMDjFXZSAw7mYEozINOfJoBBxagtWPbNHpwrMoEInBH81ik-aVCLVe0xYK",
      "city": "Detroit",
      "companyStatus": "Operating",
      "naicsDescription": "Software Publishers",
      "sicDescription": "Services-Computer Programming Services",
      "state": "MI",
      "subsidiary": "Operating",
      "companyIdMd5Hash": "9233b68f3ab250a880dda79400024785",
      "revenueCurrency": "USD",
      "industryCode": "8",
      "subIndustryCode": "8_24",
      "zip": "48226",
      "name": "Compuware Corporation",
      "britishSics": [
        {
          "britishSic": "62012",
          "description": "Business and domestic software development"
        }
      ],
      "companyFacebookProfile": "compuware",
      "companyTwitterProfile": "compuware",
      "companyBlogProfile": "http://apps.shareholder.com/rss/rss.aspx?channels=5785&companyid=CPWR&sh_auth=0.0.0.ad1dcb691ef81696c0c02ea27e385165",
      "companyLinkedInProfile": "compuware"
    }
  ],
  "totalResults": "12419465",
  "page": "1",
  "resultsPerPage": "2"
}

application/xml Example

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<companyList>
    <companies>
        <country>United States</country>
        <employees>750</employees>
        <fiscalYearEnd>0</fiscalYearEnd>
        <industry>Corporate Services</industry>
        <subIndustry>Management Consulting</subIndustry>
        <revenue>43.75</revenue>
        <sic>8742</sic>
        <naics>541611</naics>
        <companyType>Private</companyType>
        <id>3Qi2YsBVHeHgnxwhQHdwsmxxBCVh6xKgTcNVU2YEmGcq60UWkbROad4U-Ac3YzqU</id>
        <city>Boston</city>
        <companyStatus>Operating</companyStatus>
        <naicsDescription>Administrative Management and General Management Consulting Services</naicsDescription>
        <sicDescription>Services-Management Consulting Services</sicDescription>
        <state>MA</state>
        <subsidiary>Operating</subsidiary>
        <companyIdMd5Hash>073fafb94b63aeb67e769c0c1269e64c</companyIdMd5Hash>
        <revenueCurrency>USD</revenueCurrency>
        <industryCode>12</industryCode>
        <subIndustryCode>12_19</subIndustryCode>
        <zip>02199</zip>
        <name>Analysis Group, Inc.</name>
        <britishSics>
            <britishSicDetails>
                <britishSic>70229</britishSic>
                <description>Management consultancy activities other than financial management</description>
            </britishSicDetails>
            <britishSicDetails>
                <britishSic>71122</britishSic>
                <description>Engineering related scientific and technical consulting activities</description>
            </britishSicDetails>
        </britishSics>
        <companyFacebookProfile>AnalysisGroupConsulting</companyFacebookProfile>
        <companyTwitterProfile>analysisgroup</companyTwitterProfile>
        <companyBlogProfile>whsSQLi</companyBlogProfile>
        <companyLinkedInProfile>analysis-group</companyLinkedInProfile>
    </companies>

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.

Was this article helpful?
0 out of 0 found this helpful
Powered by Zendesk