For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quickstart Guide

This guide walks new users through setting up and making their first successful request for Coresignal data via no-code tools, natural language search, or the API directly, and explains where to find the reference material you'll need along the way.

Create an account

Start by creating an account. You will be able to access dashboard tools and obtain your API key, which is required to make requests and access data.

  1. Sign up at Coresignal's dashboard.

  2. You'll land on a free trial with 2,000 credits to explore with.

  3. Find your API key on the dashboard Home page, under API keys.

Make your first request

Choose the route that fits your workflow. Use dashboard tools to explore data without code, or call the API directly when you are ready to integrate.

Get started with no-code tools

You don't have to start with raw API calls. Coresignal's dashboard includes several no-code tools for exploring data, and their real value for a developer isn't just previewing results โ€“ most of them can also generate a ready-made Elasticsearch DSL query you can paste directly into your code. Here are the no-code tools available in Coresignal's dashboard:

  • AI Data Search โ€“ a chat-style tool. Describe what you want in plain English, and it finds matching records across company, employee, and jobs data. It returns a list of data that can be expanded using the enrichment feature.

  • API Playgrounds โ€“ browser-based tools for each API that guide you through building search and collect requests and returns one full record. Playgrounds generate equivalent requests in multiple formats (cURL, Python, Node.js, Ruby, and PHP) and return the response immediately.

  • Agentic Search API Playground โ€“ a dedicated no-code interface for the Agentic Search API. The API is effective for data exploration, offering preview fields and a generated Elasticsearch query suitable for multi-source APIs. The response panel also shows the total number of matches and a live request preview in cURL, Python, or Node.js, which can be easily copied into your code.

Explore APIs flow

Once you have your API key, there are a few ways to make API requests, such as using the terminal, Postman, or API Playgrounds in Coresignal's dashboard.

The common pattern across all Coresignal APIs is Search, then Collect. However, in some cases, only one request is needed to see a data preview, so always check the flows of the selected API and endpoint.

  • Search โ€“ send a query describing what you're looking for and receive a list of matching record IDs. This doesn't give you full data yet, only IDs. Search using search filters and Elasticsearch DSL is free.

  • Collect โ€“ use one of those IDs and retrieve the full record. Collect requests cost credits and return the most recent available data. If you need to collect multiple records at once, you need to use Bulk Collect request.

See the Employee Posts API example below.

1

Search for matching companies

The request returns an array of matching company IDs. This step uses the /search/filter endpoint, which accepts simple filters (e.g., name, website, industry, location, etc.). If you want more powerful boolean or fuzzy logic later, there's also a /search/es_dsl endpoint that accepts full Elasticsearch DSL queries.

2

Collect the full record for one ID

Take any ID from the search response and replace {post_id}. Request returns the full record with every field for that employee post.

What can I find in a dataset?

You can explore the available structure of any dataset or API using the provided data dictionaries and sample pages. Use the dictionary when you need to know what a specific field means or is called, and check the sample to see what you're actually going to get back before you write any code. Recommended order when starting with a new dataset: skim the sample first to see the big picture, then check the dictionary for the specific fields you plan to use.

A data dictionary is the field-by-field reference for one specific dataset or API. Before you build a query, this is what tells you what you can actually ask for and what you'll get back.

Column
What it tells you

Data field

The literal JSON key (e.g. employees_count)

Description

What the field means, returns, and related details

Data type

String, Integer, Boolean, Array of objects, etc.

A sample page shows one complete record โ€“ every category stitched together, exactly as you'd receive it from a Collect request. Where the dictionary shows you field-by-field snippets scattered across sections, the sample shows the whole thing assembled, so you can see:

  • The actual overall structure โ€“ root-level and nested data fields

  • How all the categories relate to each other in one response

Why this matters before you query

Skipping a dictionary check could lead you to expect fields that aren't present or to overlook that a chosen field could be nested within an array rather than a root-level field.

Where to go next

Check the following resources as you move from exploration to integrations. Start with query syntax, then review limits and error handling before scaling collection.

Need
Go to

Full list of every doc page

Ask a direct question about anything in the docs

The

sparkle
button at the top of any doc page

Query syntax beyond simple filters

Pulling many records at once

Rate limits / error codes

Plans and pricing

If you can't find the information, contact us

Last updated

Was this helpful?