# Multi-source Employee API

## Overview

This section covers basic information about Multi-source Employee API.\
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>Multi-source Employee API endpoints</td><td><a href="#multi-source-employee-endpoints">#multi-source-employee-endpoints</a></td></tr><tr><td>Request types</td><td><a href="#request-types">#request-types</a></td></tr><tr><td>Rate limits</td><td><a href="#rate-limits">#rate-limits</a></td></tr><tr><td>Credits</td><td><a href="#credits">#credits</a></td></tr></tbody></table>

## Multi-source Employee endpoints

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

Multi-source Employee API features **two search** and **two collect** endpoints for searching and collecting relevant Multi-source Employee data.

| Request type | Endpoint                                                             | Function                                                                   |
| ------------ | -------------------------------------------------------------------- | -------------------------------------------------------------------------- |
| POST         | */v2/employee\_multi\_source/search/es\_dsl*                         | Search for relevant employee data using Elasticsearch DSL schema           |
| POST         | */v2/employee\_multi\_source/search/es\_dsl/preview*                 | Retrieves a small set of partial data using Elasticsearch queries          |
| GET          | */v2/employee\_multi\_source/collect/{employee\_id}*                 | Collect Multi-source employee data using IDs                               |
| GET          | */v2/employee\_multi\_source/collect/{profile\_url/shorthand\_name}* | Collect Multi-source 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

Use the following endpoints to retrieve Multi-source Employee API data in bulk:

| Request type | Endpoint                                                           |
| ------------ | ------------------------------------------------------------------ |
| POST         | <p><em>/v2/data\_requests/employee\_multi\_source/ids</em><br></p> |
| POST         | */v2/data\_requests/employee\_multi\_source/es\_dsl*               |
| 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 in employee data:

| Request type | Endpoint                                            |
| ------------ | --------------------------------------------------- |
| POST         | */v2/subscriptions/employee\_multi\_source/es\_dsl* |
| POST         | */v2/subscriptions/employee\_multi\_source/ids*     |

And use the following endpoints to subscribe to employee experience updates:

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

Learn more about <a href="multi-source-employee-api/webhook-subscriptions" class="button secondary">Webhook subscriptions</a>

## Request types

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

Multi-source 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\_multi\_source/search/es\_dsl*                         |
| POST         | */v2/employee\_multi\_source/search/es\_dsl/preview*                 |
| GET          | */v2/employee\_multi\_source/collect/{employee\_id}*                 |
| GET          | */v2/employee\_multi\_source/collect/{profile\_url/shorthand\_name}* |

## Rate limits

Multi-source 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

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

* */v2/employee\_multi\_source/search/es\_dsl*
* */v2/employee\_multi\_source/search/es\_dsl/preview*

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

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

***

Read more about 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="../api-introduction/credits">credits</a></td></tr></tbody></table>