Tutorial
Read the tutorial below or watch the demo video to get an overview of the tools and the data available to you on the self-service platform.
Search and Collect credits
Search credits:
One successfully executed search query equals 1 Search Credit.
One successfully executed Multi-source company data API search query costs 2 Search Credits.
Each new user gets 400 Search Credits for free.
Collect credits:
One successfully collected profile equals 1 Collect Credit.
A successfully collected Multi-source company data record costs 2 Collect credits.
Each new user gets 200 Collect Credits for free.
How to retrieve the API token?
You can always find the API token on the Home page.
To collect your API key, simply click the copy icon in the Authentication section at the bottom right corner.
API playgrounds
We offer playgrounds for learning how find and download data and a data enrichment API playground. They are designed for testing and exploring APIs with step-by-step instructions. All playgrounds can be used to facilitate efficient API integration and onboarding. You can also use them to generate queries with simple prompts, see API request structure, and check data samples.
AI query builder
This feature is designed to simplify the way developers interact with our APIs by allowing natural language input to generate API requests.
Instead of writing detailed Elasticsearch-based queries, users can now enter a simple request such as: “Find backend developers in Austin with remote work preference.” You can also use prompt examples.
Once a request is generated, the tool provides:
The full Search and Collect requests
Matching IDs from the dataset
A sample record for immediate context
The AI Query Builder interprets the prompt, understands your intent, and constructs the appropriate Search and Collect API calls. This eliminates the need to navigate API schema or field structures manually.
The generated query and the prompt can be edited.
Enrichment API playground
The Company Enrichment API playground is connected to the Multi-Source Company Dataset. It explains how to enrich data directly via API: how to formulate your queries in different programming languages and how enriched data will look like.
You can also use this playground when you need to quickly enrich and download information about 1 or a few companies with comprehensive data using simple identifiers.
Data explorer
Filters
The API search queries consist of filters. These filters are the specific requirements that profiles need to meet, such as country is United States or job title is programmer.
You have the flexibility to use any data field from data records accessible via our Employee, Company, or Jobs API as filters. You can see the available data points in the dropdown menu of the Select filters and enter values section, or you can check the API data dictionary before getting started.
Each search tool filter comprises three parts: the field, the operator, and the value. The operator is always equal. In the visual representation below, every row of input corresponds to a single filter within the query. To add more filters to the query, simply click the Add filter button.
Conversely, you can remove the existing filters by clicking the red X button that appears next to each filter when more than one has been selected.
Please note that when you’re using the search tool, all filters are connected by the AND operation during the query evaluation process. This means that for a profile to match the query, it must satisfy all values and filters.
Building a search query
Select data
This field specifies the data type you can access. At the moment, you can access the Employee, Company, and Job posting datasets.
Select filters
In the Select filters and enter values step, you can add any filter from the dropdown menu to find relevant data records. You can select multiple filters at once. For example: country, job_title, …
Enter/Select values
This field allows you to enter unique values of the profile requirements defined by filters. Here are some examples: United States, PHP developer…
If the filter is country, then the value must be a country name, such as United States.
If there are multiple values, it can be a list of country names, such as France, Germany, United States, separated by commas (with spaces).
If the result list does not fulfill your requirements, you can adjust the search and try inserting multiple values after running the query.
Execute search
Once you have selected all filters and values, click Search. After the search query is executed, you will be able to see the number of matches in our database based on selected parameters.
The Generated sample shows a sample profile (also referred to as a data record) that matches your search criteria.
Downloading data
If you have enough credits to download all relevant data records based on your search criteria, click the Proceed to data collection button. If you don’t have enough credits, you’ll have two options:
Download some of the data records that match your search criteria using the remaining credits;
Buy more credits to get all data records that match your search criteria.
In the next step, you can choose how you want to get the data:
After you click the Generate download link button, we will start generating a direct download link for you. It can take up to 10 minutes. When the link is ready, we will notify you by email, and the link will be available on the home page next to your query for 14 days.
On the Home page, you can find all of our previous queries. Each query has one of 4 statuses:
Ready to download. You can download your data by clicking the download icon.
Preparing link. Your files are being prepared. This process takes up to 10 minutes.
Draft. You will see this status if you have generated a query and decided not to collect the data records.
Link expired. You can revisit this query and generate a link again, but if you generate a link after its expiration (after 14 days), credits will be deducted from your balance.
JSONL vs. CSV downloads
If you’re downloading data in bulk using the self-service platform, you can choose between JSONL and CSV formats, but the structure of these data files differs.
JSONL files contain full historical data, while CSV files contain the most recent data.
This difference affects collections of specific data fields.
Employee data: experience, education, and certifications. CSV files contain one most recent record from each collection, while JSONL files contain all data about experience, education, and certifications. For example, if an employee is now working at Tesla and used to work at Google, the CSV file will only show Tesla.
Company data: locations, specialties, funding rounds. CSV files contain one most recent record from each collection, while JSONL files contain all data about locations, specialties, and funding rounds.
Job posting data: industries list, functions, and functions lists. CSV files contain one most recent record from each collection, while JSONL files contain full industries lists, functions, and functions lists.
Company enricher
Upload a CSV file
To enrich data, you will need to upload a CSV file with up to 1,000 rows containing identifiers (emails or website domains) of companies you’re interested in. If needed, download the sample file first.
We will then scan and map your file. If there’s more than one column containing company identifiers, you will need to select which one you’d like to use
Confirm your request
After you submit the final file, we will show a summary of your enrichment request: how many rows were scanned, how many we can enrich based on identifiers you provided, and how many credits it will cost;
After your confirmation, the enriched CSV file will be available for download.
The enriched data will contain a column with your identifiers and six new data fields:
Name
Headquarters location
Company size
Employee count
Industry
Company profile URL
Last updated
Was this helpful?