Employee Data

🆕 Multi-source Employee API

9min

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 endpoints

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

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

Function

Endpoint

POST

/v1/multi_source/employee/search/es_dsl

GET

/v1/multi_source/employee/collect/{employee_id}

GET

/v1/multi_source/employee/collect/{shorthand_name}

Request types

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

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

Function

POST

/v1/multi_source/employee/search/es_dsl

Search for relevant employee data using Elasticsearch DSL schema

GET

/v1/multi_source/employee/collect/{employee_id}

Collect Multi-source employee data using IDs

GET

/v1/multi_source/employee/collect/{shorthand_name}

Collect Multi-source employee data using shorthand names*

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

Rate limits

Multi-source Employee API endpoints restrict the number of requests allowed per second for each client's API token.

Multi-source API search endpoint

Multi-source API collection endpoints

Allows 18 requests per second.

Allow 54 requests per second.

Credits and tokens

The token issued for you has a set amount of search and collect credits.

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

  • /v1/multi_source/employee/search/es_dsl


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

  • /v1/multi_source/employee/collect/{employee_id}
  • /v1/multi_source/employee/collect/{shorthand_name}

Discuss your credit needs with your account manager.

Data dictionaries and samples

Explore data points in Multi-source Employee data: