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:

Base Employee API endpoints

Rate limits

Credits

Base Employee API endpoints

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

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

Endpoint	Function	Credits
POST /v2/employee_base/search/filter	Search for relevant employee profiles using search filters	Free
POST /v2/employee_base/search/filter/preview	Retrieves a small set of partial data using search filter	10
POST /v2/employee_base/search/es_dsl	Search for relevant employee profiles using Elasticsearch DSL schema	Free
POST /v2/employee_base/search/es_dsl/preview	Retrieves a small set of partial data using Elasticsearch queries	10
GET /v2/employee_base/collect/{employee_id}	Collect Base Employee data using IDs	10
GET /v2/employee_base/collect/{profile_url/shorthand_name}	Collect Base Employee data using profile URLs or shorthand names*	10

*📌 Full profile URL example: 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.

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

Base Employee API supports two types of requests:

• Search endpoints support POST requests only.

• Collect endpoints support the GET requests only.

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}

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:

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 Webhook subscriptions