Search & Filter Companies

Request

Retrieve a list of companies and their corresponding details.

Security

authorization

Bodyapplication/jsonrequired

Search for companies

fieldsArray of strings or null(SelectedCompanySearchFields)required

List of fields to be selected.

Default:["company_id","company_name","domain_name","domain_name_normalized"]

Example:

[
  "company_id",
  "company_name",
  "domain_name",
  "domain_name_normalized"
]

filtersobject(CompanyFilters)required

Filters object

Example:

{
  "company_identifiers": {
    "company_ids": { … }
  },
  "corporate_hierarchy": {
    "is_domestic_parent": true,
    "is_global_headquarters": true
  },
  "firmographics": {
    "country_codes": [ … ],
    "employees": { … },
    "industries": [ … ],
    "region_names": { … },
    "revenue": { … }
  },
  "installs": {
    "product_attributes": { … },
    "product_categories": { … },
    "products": [ … ],
    "vendors": [ … ]
  },
  "intent": {
    "context_type_ids": { … },
    "location": { … },
    "signal_score": "MEDIUM",
    "topics": { … }
  },
  "spend": [
    { … }
  ]
}

limitinteger, <= 1000(Limit)

The number of records to return in the request.

Default:10

Example:10

offsetinteger, >= 0(Offset)

Used for paginating records.

Default:0

Example:0

sortsArray of objects(CompanyFieldSorts)

List of Sort objects

Default:[{"direction":"ASC","field":"company_name"}]

Example:

[
  {
    "direction": "DESC",
    "field": "company_name"
  }
]

curl -i -X POST \
  https://api.hginsights.com/data-api/v1/company/search \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
      "company_id",
      "company_name",
      "domain_name",
      "domain_name_normalized"
    ],
    "filters": {
      "company_identifiers": {
        "company_ids": {
          "ids": [
            "1698C53EBC888758570396E0334965C1"
          ],
          "inclusion_method": "ANY_PRESENT"
        }
      },
      "corporate_hierarchy": {
        "is_domestic_parent": true,
        "is_global_headquarters": true
      },
      "firmographics": {
        "country_codes": [
          {
            "ids": [
              "US"
            ],
            "inclusion_method": "ANY_PRESENT"
          }
        ],
        "employees": {
          "max": 2500000,
          "min": 1500000
        },
        "industries": [
          {
            "ids": [
              16
            ],
            "inclusion_method": "ANY_PRESENT"
          }
        ],
        "region_names": {
          "ids": [
            "AMER"
          ],
          "inclusion_method": "ANY_PRESENT"
        },
        "revenue": {
          "max": 700000000000,
          "min": 600000000000
        }
      },
      "installs": {
        "product_attributes": {
          "ids": [
            222
          ],
          "inclusion_method": "ANY_PRESENT",
          "install_age_months": {
            "max": 18,
            "min": 3
          }
        },
        "product_categories": {
          "ids": [
            "319D067B229178F03BCFA1DA4AC4DEDE"
          ],
          "inclusion_method": "ANY_PRESENT",
          "install_age": {
            "max": 12
          }
        },
        "products": [
          {
            "fai": {
              "departments": {
                "ids": [
                  "A1B2C3D4E5F6A1B2C3D4E5F6A1B2C3D4"
                ],
                "inclusion_method": "ANY_PRESENT"
              }
            },
            "ids": [
              814
            ],
            "inclusion_method": "ANY_PRESENT",
            "install_age": {
              "max": 24,
              "min": 6
            }
          }
        ],
        "vendors": [
          {
            "ids": [
              316
            ],
            "inclusion_method": "ANY_PRESENT",
            "product_count": {
              "min": 5
            }
          }
        ]
      },
      "intent": {
        "context_type_ids": {
          "ids": [
            "DEF456789012345678901234ABCDEF12"
          ],
          "inclusion_method": "ANY_PRESENT"
        },
        "location": {
          "country_alpha2s": [
            {
              "ids": [
                "US",
                "CA"
              ],
              "inclusion_method": "ANY_PRESENT"
            }
          ]
        },
        "signal_score": "MEDIUM",
        "topics": {
          "ids": [
            "19861D3AC60455102792F87A33AF533F"
          ],
          "inclusion_method": "ANY_PRESENT"
        }
      },
      "spend": [
        {
          "categories": {
            "ids": [
              "3B36D42E7F8E60BE58BA4356B6AF40C"
            ],
            "inclusion_method": "ANY_PRESENT"
          },
          "range": {
            "min": 2000000000
          }
        }
      ]
    },
    "limit": 10,
    "offset": 0,
    "sorts": [
      {
        "direction": "DESC",
        "field": "company_name"
      }
    ]
  }'

Responses

Search Companies Response

Bodyapplication/json

countinteger

The total number of companies that match the search criteria.

dataArray of objects(CompanyObjectIdentifiers)

Response

{
  "count": 0,
  "data": [
    { … }
  ]
}