Supercharge your product or your sales machine with our enrichment API for companies and employees
API Documentation
The Companies API is built using the REST architecture. Our routes accept request bodies encoded in the form format and return responses encoded in the JSON format. You can jump from one feature to another with the navigation menu on your left. Examples with real responses are provided on the right side of the page.
Authentication
The Companies API uses API token to authenticate requests.
You can manage your API tokens in your settings or on the right side of this section.
There are two ways to authenticate your HTTP requests to the API:
- By adding an Authorization header. The Authorization header is formatted as such: Authorization: Basic MY-API-TOKEN (replace MY-API-TOKEN with one of yours).
- By sending the API token as a GET parameter. Like this ?token=MY-API-TOKEN (mostly used to quickly test a endpoint).
Errors & Rate-Limiting
The Companies API uses conventional HTTP response codes to indicate the success or failure of an API request. Generally, Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted). Codes in the 5xx range indicate an error with our servers (these are rare).
Some 4xx errors that could be handled programmatically include an error code that briefly explains what went wrong.
Error object
Webhooks
The Companies API uses webhooks to notify you about changes or when an operation ends.
You can manage your webhooks on the right side of this section or in your settings.
Webhooks are helpful for receiving the results of our algorithms. For instance, when a new company you have requested has been scrapped or when we have found a new employee for one of your dynamic lists.
Companies
You will find all our features regarding our database of companies below.
Search companies with a specific condition or by name. Retrieve the profile of a particular business by providing its domain name or one of its social network URLs. Do you also need to get similar companies or even the email patterns they use? We got you covered.
Search companies
0.25 credit
per company
Do you need to search companies located in a given country for a specific industry and that use a particular technology? Combine our conditions and create powerful search queries to identify them.
Query
Response
Search companies by name
1 credit
Retrieve a company profile by providing the company name. You can use this endpoint if you need more information about the company, but be careful. Two companies can have the same name—for example, Bolt. That's why this feature can return multiple companies.
Query
Response
Enrich a company from a domain
1 credit
Enrich a company by sending us its domain name. The domain name is a better identifier than the company name because it is unique and less prone to typos.
Query
Response
Find similar companies
0.25 credit
per company
Send us one or more domains and we will return a list of similar companies.
Query
Response
Find email patterns for a domain
1 credit
Send us a domain name and retrieve all the email patterns they use with the usage percentage.
Query
Response
Employees
We design algorithms to identify employees in real-time or enrich them when you need their email address or profile information. You will find all our features below.
Identify employees in real-time
10 credits
Search for employees with certain job titles inside a company. The company domain name is required, but job titles aren't. You can also use conditions the employees must match for more complicated queries (see query parameter).
You can also send the id of one of your lists to save the employees. If you don't have any list, you can create one with our endpoint to create a list.
Query
Response
Discover an employee's email
5 credits
Use our algorithms to find and verify an employee's email address. Send us the employee's first name, last name, middle name, and/or employee id, and we will do the rest.
Query
Response
Enrich an employee from his email
1 credit
Send us a professional email, and we will enrich it with the company profile as well as data points about the employee (see list below).
Query
Response
Industries
Search for specific industries and get information as the number of companies it contains.
Search industries Free
Search our industries database and get information such as the number of companies it contains. Results are sorted by domains_count.
Query
Response
Job Titles
You will find all our features regarding our database of job titles below. Search or enrich job titles with the departments and the seniority levels. You can use these features to provide more context to your customers inside your CRM or to find specific employees with our algorithms.
Enrich a job title from its name Free
Send us a job title (e.g., chief marketing officer) and retrieve additional information like the departments and the seniority levels. We support the following languages: English, French, and Spanish.
Query
Response
Locations
The following endpoints let you search all our locations: cities, counties, states, countries, and continents.
Search cities Free
Search our cities to filter companies or target employees in a specific location.
Query
Response
Search counties Free
Search our counties to filter companies or target employees in a specific location.
Query
Response
Search states Free
Search our states to filter companies or target employees in a specific location.
Query
Response
Search countries Free
Search our countries to filter companies or target employees in a specific location.