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.
Of course, if you need help with anything or want to see additional features, feel free to reach us in the chatbox. We are usually quick to implement them.
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.
Your API tokens carry many privileges, so keep them secure! Please do not share them in publicly accessible areas such as GitHub, client-side code, etc. Those authentication keys are permanent (they never expire). You can consider them safe for long-term purposes.
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).
Please note that you can only use HTTPS to access the API. HTTP is not supported.
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.
We consider the credit system a rate-limit system by design. Some free API features such as the job titles, industries, and others have a rate limit security. Contact us with your use case if you plan to use them in a high volume.
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.
We are always looking for new ways to use webhooks. If you have any suggestion, please let us know.
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.
An important concept to keep in mind is that we represent a company by its domain name (e.g., gucci.com). This is what we use as a unique key. That means that when we discover a new domain name, we consider it a new company.
Search companies0.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.
To help you create your first conditions, we have designed a generator below. We would also be glad to help you if you need it.
Query parameters
Response
Search companies by name1 Credit per call
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.
If you have a company's domain name, it's better to use it. We use it as a unique key in our database. See our endpoint below.
Query parameters
Response
Enrich a company from a domain1 Credit per enrichment
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.
We return more than 50 data points including the industries, the revenue, the technologies… If you need something we do not have yet, please let us know.
Query parameters
Response
Count companies matching your queryFree
Count the companies matching your conditions. Useful if you are building your own search engine for companies.
Response
Find similar companies0.25 Credit per similar company
Send us one or more domains and we will return a list of similar companies.
This API feature is one of the most powerful. You can use it to find similar companies to your own, or to find companies that are similar to your customers. You can also use it to find companies that are similar to your competitors. The possibilities are endless.
Query parameters
Response
Find email patterns for a domain1 Credit
Send us a domain name and retrieve all the email patterns they use with the usage percentage.
We use this feature internally to prioritize the patterns when we want to guess and verify a business email address with external APIs. You can use this endpoint to decrease your API calls to tools like MailboxLayer or Debounce (and therefore your costs).
Query parameters
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.
If you need additional endpoints, feel free to contact us. We are usually fast to implement them.
Identify employees in real-time10 Credits per employee
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.
You may wonder why our technology searches employees in real-time. From our experience (we were one of them), most services that rely on a database of employees take the risk of having outdated information. People leave from one job to another, get promoted, etc. This issue will never be one with us. The only downside is that it can take a few seconds to get the results.
Query parameters
Response
Discover an employee's email5 Credits per email found
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.
We don't deduct credits when you provide the employee's id or when we can't figure out the email address.
Query parameters
Response
Enrich an employee from his/her email1 Credit per enrichment
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).
If you need a specific data point, please ask us for it.
Query parameters
Response
Industries
Search for specific industries and get information as the number of companies it contains.
We currently have over 3 million industries in our database. We can send you a file with our 100,000 most popular industries if you want to use it in your application.
Search industriesFree
Search our industries database and get information such as the number of companies it contains. Results are sorted by "companies_count".
Query parameters
Response
Find similar industriesFree
Discover similar industries with our API. Identify related sectors and expand your business opportunities.
Query parameters
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.
If you need additional features, feel free to reach us in the chatbox. We are usually fast to implement them.
Enrich a job title from its nameFree
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.
Our database includes more than 165,000 job titles categorized in 70 departments and 10 seniority levels.
query
Response
Locations
The following endpoints let you search all our locations: cities, counties, states, countries, and continents.
ou can use them to filter our companies or target employees in a specific location.
Search citiesFree
Search our cities to filter companies or target employees in a specific location.
Query parameters
Response
Search countiesFree
Search our counties to filter companies or target employees in a specific location.
Query parameters
Response
Search statesFree
Search our states to filter companies or target employees in a specific location.
Query parameters
Response
Search countriesFree
Search our countries to filter companies or target employees in a specific location.
Query parameters
Response
Search continentsFree
Search our continents to filter companies or target employees in a specific location.
Query parameters
Response
Lists
Companies and employees can be saved in your lists. The following endpoints let you retrieve your lists and deal with the companies and employees that belong to them.
Fetch your listsFree
This endpoint allows you to retrieve the lists that belong to your team.
Query parameters
Response
Create a list of companies or employeesFree
This endpoint allows you to create a list of companies or employees.
Query parameters
Response
Fetch companies in your listFree
This endpoint allows you to fetch companies in your lists.
Query parameters
Response
Fetch employees in your listFree
This endpoint allows you to fetch the employees in your lists.