Company API

This page provides detailed information on how to retrieve company information through our 2 main API's the search: /api/company/search and export: /api/company/export endpoints. These endpoints allow you to retrieve, search, and export information about companies, with a variety of filtering options such as country, city, industry etc.

Endpoint: /api/company/search

The /api/company/search endpoint allows users to search for companies based on various criteria. This endpoint returns a standard set of fields, including the company name and address.

Returned Fields

  • ID: A unique identifier of the company, can be used to retrieve a full record.
  • Company Name: The main name of the company.
  • Country Name: The country of the company.

Note: it's possible to receive more fields on search, this can be requested via support.

Important Notes

  • Purpose: This endpoint is primarily used to retrieve basic information such as the company name and address based on a search query. For instance in an autocomplete search.
  • Filtering branches: In most cases, you'll want to add statusCode=0,1 to your query. This filters for single locations (0) and headquarters (1) only. Large companies often have many branches/subsidiaries in the database, which are typically not relevant for most use cases like lead generation or company lookup.

Example Request

curl -G https://app.companydata.com/api/company/search \
  -H "x-api-key: {ApiKey}" \
  -d "search=Example Company"

Additional Examples

1. Search for companies named Bolddata

GET
/api/company/search
curl -G https://app.companydata.com/api/company/search?page=1&pageSize=25&search=BoldData \
  -H "x-api-key: {ApiKey}"

2. Search for companies named Bolddata in The NETHERLANDS

GET
/api/company/search
curl -G https://app.companydata.com/api/company/search?page=1&pageSize=25&search=BoldData&countryCode=NL \
  -H "x-api-key: {ApiKey}"

Company Export

Endpoint: /api/company/export

The /api/company/export endpoint allows users to request a specific set of fields related to company data. The fields returned by this endpoint depend on the type of package purchased by the client.

Returned Fields

  • The set of fields returned is determined by the client's subscription package. This could include detailed company information such as financial data, employee count, or contact information.

Important Notes

  • Package-Dependent Fields: The fields returned by this endpoint are customized based on the client's purchased package. For more information contact support.
  • Use Case: This endpoint is used for getting a full company profile, often used in CRM's or for purposing of contacting or researching a company.

Example Request

Export the first 25 companies from Rotterdam, the Netherlands with the Sic Code 3221, for glassware.

curl -G https://app.companydata.com/api/company/export?page=1&pageSize=25&sic4Digits=3221&countryCode=NL&cityName=Rotterdam? \
  -H "x-api-key: {ApiKey}" \
  -d "export=true"

Query Parameters

Below is a list of query parameters that can be used to filter the results returned by this endpoint. Export and search support the same parameters.

ParameterDescriptionTypeOptionsExample
IDCompany IDStringCompany IDID=01111
searchSearch for company nameStringCompany Namesearch=Bolddata
sic4Digits4-digit SIC Code.StringA valid 4 number SIC Codesic4Digits=0111,0115
importExportCodeImport/Export Code.EnumA: Import/Export/Agent, B: Imports & Exports, C: Imports, D: Imports & Agents, E: Exports & Agents, F: Agent (no inventory), G: Not available, H: ExportsimportExportCode=B,C
legalStatusLegal Status of the company.Enum0: Not available, 1: Proprietorship, 2: Partnership, 3: Corporation, 7: Partnership, 8: Joint venture, 9: Master limited partnership, etc.legalStatus=1,2
statusCodeStatus Code representing the company's location type.Enum0: Single Location, 1: Headquarter/Parent, 2: BranchstatusCode=0,2
subsidiaryCodeIndicates if the company is a subsidiary.Enum0: Not a subsidiary, 3: Is a subsidiarysubsidiaryCode=3,0
countryCodeCountry Code where the company is located.StringSee countries page for code formatcountryCode=AL,BY,NL
provinceNameState/Province Name where the company is located.AutoCompleteN/AprovinceName=NOORD-HOLLAND
cityNameCity Name where the company is located.AutoCompleteN/AcityName=AMSTERDAM
employeesHereNumber of employees at the company's location.IntegerExample: 10employeesHere[min]=2&employeesHere[max]=10
employeesTotalTotal number of employees in the company.IntegerExample: 100employeesTotal[min]=2&employeesTotal[max]=10
annualSalesAnnual sales in U.S. dollars.IntegerExample: 100000annualSales[min]=10000&annualSales[max]=500000
foundingYearsRange of years the company was founded.IntegerExample: 2022foundingYears[min]=2000&foundingYears[max]=2010
phoneNumberSearch by full Company's Phone number, internationally formatted with + sign, 00 or local not supportedStringCompany Phone NumberphoneNumber=+31621700000
emailSearch by email or email patterns such as domain or namesStringCompany Emailsearch=bolddata.nl search=info@bolddata.nl
worldwideHeadquarterIDFilter by Worldwide Headquarter IDStringWorldwide Headquarter IDworldwideHeadquarterID=1234
nationalIdSearch by National Company Registration Number, recommended to add countryCodeStringNational Company Registration NumbernationalId=123456
hasEmailIndicates if an email address is available for the company.Booleantrue, falsehasEmail=true
hasMarketabilityIndicates if the company is marked as marketable.Booleantrue, falsehasMarketability=true
hasPhoneIndicates if a telephone number is available for the company.Booleantrue, falsehasPhone=true
hasFaxIndicates if a fax number is available for the company.Booleantrue, falsehasFax=true
hasContactPersonIndicates if a contact person is available for the company.Booleantrue, falsehasContactPerson=true
hasWebsiteIndicates if a website is available for the company.Booleantrue, falsehasWebsite=true
hasNationalIDIndicates if a national ID is available for the company.Booleantrue, falsehasNationalID=true
hasBusinessNameIndicates if a business name is available for the companyBooleantrue, falsehasBusinessName=true
hasStreetAddressIndicates if a street address is available for the company.Booleantrue, falsehasStreetAddress=true
hasPostalCodeIndicates if a postal code is available for the company.Booleantrue, falsehasPostalCode=true
hasCEONameIndicates if a CEO name is available in the database for the company record.Booleantrue, falsehasCEOName=true

Was this page helpful?