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:

Multi-source Employee API endpoints

Request types

Rate limits

Credits

Multi-source Employee endpoints

Our API is a data retrieval tool. The endpoints do not support analytic features.

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/{shorthand_name}	Collect Multi-source employee data using shorthand names*

*📌 Full profile URL example: www.professional-network.com/in/john-doe. Shorthand name example: john-doe.

Request types

All Multi-source Employee API requests must be made over HTTPS. Requests made over HTTP will fail or be redirected to HTTPS.

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/{shorthand_name}

Bulk Collect

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

Request type	Endpoint
POST	/v2/data_requests/employee_multi_source/ids
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}

Rate limits

Multi-source Employee API endpoints restrict the number of requests allowed per second.

Search endpoints

Collection endpoints

Bulk Collect search and collection endpoints

18 requests per second

54 requests per second

27 requests per second

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/{shorthand_name}

---

Read more about credits in the following topic:

General information about credits