# Base Employee API

## Overview

This section covers basic information on the Base Employee API endpoints.\
To learn more about the API and its endpoints, follow the links below:

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>Base Employee API endpoints</td><td><a href="/pages/qWtTcCtdQeRrl5PJDzdT#base-employee-api-endpoints">/pages/qWtTcCtdQeRrl5PJDzdT#base-employee-api-endpoints</a></td></tr><tr><td>Request types</td><td><a href="/pages/qWtTcCtdQeRrl5PJDzdT#request-types">/pages/qWtTcCtdQeRrl5PJDzdT#request-types</a></td></tr><tr><td>Rate limits</td><td><a href="/pages/qWtTcCtdQeRrl5PJDzdT#rate-limits">/pages/qWtTcCtdQeRrl5PJDzdT#rate-limits</a></td></tr><tr><td>Credits</td><td><a href="/pages/qWtTcCtdQeRrl5PJDzdT#credits">/pages/qWtTcCtdQeRrl5PJDzdT#credits</a></td></tr></tbody></table>

## Base Employee API endpoints

{% hint style="info" %}
Our API is a data retrieval tool. The endpoints do not support analytic features.
{% endhint %}

Base Employee API features **four search** and **two collect** endpoints for searching and collecting relevant Base Employee data.

| Request type | Endpoint                                                    | Function                                                             |
| ------------ | ----------------------------------------------------------- | -------------------------------------------------------------------- |
| POST         | */v2/employee\_base/search/filter*                          | Search for relevant employee profiles using search filters           |
| POST         | */v2/employee\_base/search/filter/preview*                  | Retrieves a small set of partial data using search filter            |
| POST         | */v2/employee\_base/search/es\_dsl*                         | Search for relevant employee profiles using Elasticsearch DSL schema |
| POST         | */v2/employee\_base/search/es\_dsl/preview*                 | Retrieves a small set of partial data using Elasticsearch queries    |
| GET          | */v2/employee\_base/collect/{employee\_id}*                 | Collect Base Employee data using IDs                                 |
| GET          | */v2/employee\_base/collect/{profile\_url/shorthand\_name}* | Collect Base Employee data using profile URLs or shorthand names\*   |

\*📌 Full profile URL example: [www.professional-network.com/\*\*john-doe\*\*.\\](http://www.professional-network.com/**john-doe**.\\)
Shorthand name example: john-doe.

### Bulk Collect

Bulk Collect (Bulk API) expands upon Base Employee API's functionality, featuring **five POST** and **two** **GET** endpoints.

| Request type | Endoint                                                     |
| ------------ | ----------------------------------------------------------- |
| POST         | */v2/data\_requests/employee\_base/ids*                     |
| POST         | */v2/data\_requests/employee\_base/es\_dsl*                 |
| POST         | */v2/data\_requests/employee\_base/filter*                  |
| POST         | */v2/data\_requests/employee\_base/shorthand\_names*        |
| POST         | */v2/data\_requests/employee\_base/urls*                    |
| GET          | */v2/data\_requests/{data\_request\_id}/files*              |
| GET          | */v2/data\_requests/{data\_request\_id}/files/{file\_name}* |

### Webhook subscriptions

Webhooks enable you to receive automatic, event-driven notifications when changes are detected in your subscribed employee profiles.

Use the following endpoints to subscribe to profile changes:

| Request type | Endpoint                                   |
| ------------ | ------------------------------------------ |
| POST         | */v2/subscriptions/employee\_base/es\_dsl* |
| POST         | */v2/subscriptions/employee\_base/filter*  |
| POST         | */v2/subscriptions/employee\_base/ids*     |

Use the following endpoints to subscribe to employee experience updates:

| Request type | Endpoint                                                       |
| ------------ | -------------------------------------------------------------- |
| POST         | */v2/subscriptions/experience\_changes/employee\_base/ids*     |
| POST         | */v2/subscriptions/experience\_changes/employee\_base/es\_dsl* |

Learn more about <a href="/pages/0xAjxVOnfexbp1HCoISN" class="button secondary">Webhook subscriptions</a>

## Request types

{% hint style="warning" %}
All Base Employee API requests must be made over HTTPS. Requests made over HTTP will fail or be redirected to HTTPS.
{% endhint %}

Base Employee API supports two types of requests:

* **Search** endpoints support POST requests only.
* **Collect** endpoints support the GET requests only.

| Request type | Endpoint                                                    |
| ------------ | ----------------------------------------------------------- |
| POST         | */v2/employee\_base/search/filter*                          |
| POST         | */v2/employee\_base/search/filter/preview*                  |
| POST         | */v2/employee\_base/search/es\_dsl*                         |
| POST         | */v2/employee\_base/search/es\_dsl/preview*                 |
| GET          | */v2/employee\_base/collect/{employee\_id}*                 |
| GET          | */v2/employee\_base/collect/{profile\_url/shorthand\_name}* |

## Rate limits

Base Employee API endpoints restrict the number of requests allowed per second.

{% columns %}
{% column %}
Search endpoints

Collection endpoints

Bulk Collect search and collection endpoints
{% endcolumn %}

{% column %}
18 requests per second

54 requests per second

27 requests per second
{% endcolumn %}
{% endcolumns %}

## Credits

**One** search credits are deducted for **one successful (200) request** in the search endpoint:

* */v2/employee\_base/search/filter*
* */v2/employee\_base/search/filter/preview*
* */v2/employee\_base/search/es\_dsl*
* */v2/employee\_base/search/es\_dsl/preview*

**One** collection credits are deducted for **one successful (200) request** in the collection endpoints:

* */v2/employee\_base/collect/{employee\_id}*
* */v2/employee\_base/collect/{profile\_url/shorthand\_name}*

***

Read more about the credits in the following topic:

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td>General information about credits</td><td><a href="/pages/B1zFzH84OnIoh2EnKrvE">/pages/B1zFzH84OnIoh2EnKrvE</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.coresignal.com/employee-api/base-employee-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.