# Company APIs

Use the API playground at <https://api.salesintel.io> to test the API request and response patterns.

## Retrieve companies matching filter parameters

<mark style="color:blue;">`GET`</mark> `https://api.salesintel.io/service/company`

You can also use this endpoint to append information to identified companies, using the company\_domain or companyname parameter to specify the company. Company domain is preferred matching approach to retrieve specific companies, as it is inherently standardized. If domain is unavailable, company name can be used, but you should attempt some normalization of your entries, particularly by removing suffixes like inc, corp, co, llc, etc, to ensure the best match rate.

The response set is paginated, with up to 50 records per page. You are charged credits based on the number of records on the pages accessed. If you only retrieve the first page of results out of 10, at a page size of 50, you will be charged for 50 records. The page size is adjustable below 50, but not greater than 50. Regardless of page size, you can only paginate 10,000 records deep in any given results set.

## Query Parameters

| Name                                  | Type    | Description                                                                                                                                                                                                                                                                                                                                   |
| ------------------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| company\_domain                       | String  | Comma-separated list of domains                                                                                                                                                                                                                                                                                                               |
| company\_industries                   | String  | Obsolete                                                                                                                                                                                                                                                                                                                                      |
| company\_location\_states             | String  | Comma-separated list of state/region abbreviations (ISO standards)                                                                                                                                                                                                                                                                            |
| company\_location\_zipcodes           | String  | Comma-separated list of ZIP/postal codes                                                                                                                                                                                                                                                                                                      |
| company\_location\_zipcodes\_distance | Long    | Radius (in miles) from provided ZIP codes (US only)                                                                                                                                                                                                                                                                                           |
| company\_max\_revenue                 | Integer | Maximum annual revenue (in millions)                                                                                                                                                                                                                                                                                                          |
| company\_max\_size                    | Integer | Maximum company employee size                                                                                                                                                                                                                                                                                                                 |
| company\_min\_revenue                 | Integer | Minimum annual revenue (in millions)                                                                                                                                                                                                                                                                                                          |
| company\_min\_size                    | Integer | Minimum company employee size                                                                                                                                                                                                                                                                                                                 |
| company\_naics\_codes                 | String  | Comma-separated list of NAICS codes                                                                                                                                                                                                                                                                                                           |
| company\_name                         | String  | Comma-separated list of names; names are not case-sensitive and are matched using "contains"                                                                                                                                                                                                                                                  |
| company\_sic\_codes                   | String  | Comma-separated list of SIC codes                                                                                                                                                                                                                                                                                                             |
| is\_international                     | Boolean | Company is located in the US (false) or outside of the US (true). Without this parameter, you may return multiples of the same organization based in different countries                                                                                                                                                                      |
| location\_country\_codes              | String  | Comma-separated list of ISO alpha-2 country codes                                                                                                                                                                                                                                                                                             |
| specialties                           | String  | Comma-separated list of keywords that describe a company                                                                                                                                                                                                                                                                                      |
| tech\_category                        | String  | Tilda (\~) - separated lists of technographic categories in use by the company (this filter requires add-on permissions; use the [technologies taxonomy API](https://developer.salesintel.io/salesintel-api-documentation/technographic-apis#retrieve-the-category-subcategory-technology-taxonomy) to identify supported categories)         |
| tech\_subcategory                     | String  | Tilda (\~) - separated lists of technographic sub-categories in use by the company (this filter requires add-on permissions; use the [technologies taxonomy API](https://developer.salesintel.io/salesintel-api-documentation/technographic-apis#retrieve-the-category-subcategory-technology-taxonomy) to identify supported sub-categories) |
| tech\_product                         | String  | Tilda (\~) - separated lists of technographic products in use by the company (this filter requires add-on permissions; use the [technologies taxonomy API](https://developer.salesintel.io/salesintel-api-documentation/technographic-apis#retrieve-the-product-vendor-technology-taxonomy) to identify supported products)                   |
| tech\_vendor                          | String  | Tilda (\~) - separated lists of technographic vendors in use by the company (this filter requires add-on permissions; use the [technologies taxonomy API](https://developer.salesintel.io/salesintel-api-documentation/technographic-apis#retrieve-the-product-vendor-technology-taxonomy) to identify supported vendors)                     |
| verified                              | Boolean | Company details are human verified (true) or machine verified (false). Without this parameter, you may return multiples of the same organization                                                                                                                                                                                              |
| page                                  | Integer | Page number                                                                                                                                                                                                                                                                                                                                   |
| page\_size                            | Integer | If not specified, the default page size is 50 records                                                                                                                                                                                                                                                                                         |
| sort\_by                              | String  | Sort field, either company\_name or company\_location                                                                                                                                                                                                                                                                                         |
| sort\_direction                       | String  | Sort direction, either asc or desc                                                                                                                                                                                                                                                                                                            |

## Headers

| Name                                          | Type   | Description      |
| --------------------------------------------- | ------ | ---------------- |
| X-CB-ApiKey<mark style="color:red;">\*</mark> |        | {your API key}   |
| Accept<mark style="color:red;">\*</mark>      | String | application/json |

## Response

{% tabs %}
{% tab title="200: OK" %}
200: OK

To see the full response, use the playground at <https://api.salesintel.io>
{% endtab %}

{% tab title="401: Unauthorized" %}
401: Unauthorized&#x20;

You have not included your credentials properly in your request
{% endtab %}

{% tab title="402: Payment Required" %}
402: Payment Required&#x20;

You do not have enough credits to return any/all of your request
{% endtab %}

{% tab title="403: Forbidden" %}
403: Forbidden&#x20;

Your account does not have the necessary permissions to access this service
{% endtab %}

{% tab title="500: Internal Server Error" %}
500: Internal Server Error&#x20;

There may be an outage on the SalesIntel side. If the error persists, please contact us.
{% endtab %}
{% endtabs %}

{% hint style="info" %}
Be sure to review the `is_international` and `verified` params to ensure that the companies returned meet your needs
{% endhint %}

{% code title="Response Model" %}

```json
{
  "aggregations": {},
  "batch_id": {},
  "error": "string",
  "is_preview": true,
  "page": 0,
  "page_size": 0,
  "result_count": 0,
  "search_results": [
    {
      "_score": {},
      "addresses": [
        {
          "city": "string",
          "country": "string",
          "is_hq": true,
          "location_id": 0,
          "state": "string",
          "street_1": "string",
          "street_2": "string",
          "type": "string",
          "zip": "string"
        }
      ],
      "cds_batch_id": {},
      "company": {
        "actual_revenue": 0,
        "domains": [
          "string"
        ],
        "id": 0,
        "linkedin_url": "string",
        "naics_codes": [
          "string"
        ],
        "name": "string",
        "predicted_revenue": 0,
        "revenue": 0,
        "revenue_range": "string",
        "sic_codes": [
          "string"
        ],
        "size": 0,
        "size_range": "string"
      },
      "company_actual_revenue": 0,
      "company_domains": [
        "string"
      ],
      "company_id": 0,
      "company_name": "string",
      "company_predicted_revenue": 0,
      "company_revenue": 0,
      "company_revenue_range": "string",
      "company_score": {},
      "company_size": 0,
      "company_size_range": "string",
      "company_status": {},
      "dates": {
        "created_date": "string",
        "last_modified_date": "string"
      },
      "display_name": "string",
      "doc_id": "string",
      "email": "string",
      "email_hash": "string",
      "firmographic": {},
      "first_name": "string",
      "industry": "string",
      "intent": {},
      "is_executive": true,
      "is_international": true,
      "job_department": "string",
      "job_level": "string",
      "job_title": "string",
      "last_name": "string",
      "linkedin_url": {},
      "location": "string",
      "location_type": {},
      "locations": {},
      "logo_url": {},
      "match_id": "string",
      "naics_code": "string",
      "other_emails": [
        "string"
      ],
      "person_id": 0,
      "personal_addresses": [
        {
          "city": "string",
          "country": "string",
          "is_hq": true,
          "location_id": 0,
          "state": "string",
          "street_1": "string",
          "street_2": "string",
          "type": "string",
          "zip": "string"
        }
      ],
      "personal_email": "string",
      "personal_email_hash": "string",
      "phone_numbers": [
        {
          "country_code": "string",
          "hash": "string",
          "type": "string",
          "value": "string"
        }
      ],
      "position_location_hashid": "string",
      "position_location_id": 0,
      "prefix": "string",
      "primary_country": {},
      "primary_domain": {},
      "primary_name": {},
      "relations": {},
      "revenue_range": "string",
      "sector": "string",
      "sic_code": "string",
      "size_range": "string",
      "social_profiles": [
        {
          "type": "string",
          "url": "string"
        }
      ],
      "specialties": {},
      "status_reason": {},
      "suffix": "string",
      "tags": {},
      "technographics": {},
      "tier": 0,
      "tier_counts": {},
      "topics": [
        {
          "category": "string",
          "topic_id": 0,
          "topic_name": "string"
        }
      ],
      "verified": true
    }
  ],
  "sort_by": "string",
  "sort_direction": "string",
  "took": 0,
  "total_count": 0,
  "tracking_id": "string"
}
```

{% endcode %}
