Employee API

Overview

This section covers the basics of the Employee Data API. For more on the API and its endpoints, follow the links below.

Employee API endpoints

Employee data dictionary

Full employee data sample

Rate limits

Credits

Our API retrieves data. The endpoints do not support analytic features.

---

Employee API endpoints

Employee API features three search (POST) and two collect (GET) endpoints for searching and collecting relevant employee data.

Endpoint	Function	Credits
POST /v2/employee_multi_source/search/es_dsl	Search for relevant employee data using Elasticsearch DSL schema	Free
POST /v2/employee_multi_source/semantic_search/es_dsl	Search for relevant employee data using Elasticsearch DSL schema with applied semantic search	Free
POST /v2/employee_multi_source/search/es_dsl/preview	Retrieves a preview set of partial data using Elasticsearch queries	20
GET /v2/employee_multi_source/collect/{employee_id}	Collect employee data using IDs	20
GET /v2/employee_multi_source/collect/{profile_url/shorthand_name}	Collect employee data using profile URLs or shorthand names*	20

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

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

Bulk Collect

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

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}

Read more about Bulk Collect in the following article:

Bulk Collect

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:

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:

Endpoint
POST /v2/subscriptions/experience_changes/employee_multi_source/ids
POST /v2/subscriptions/experience_changes/employee_multi_source/es_dsl

Learn more about Webhook subscriptions