Clean Employee API

Overview

This section covers basic information on the Clean Employee API endpoints. To learn more about the API and its endpoints, follow the links below:

Clean Employee API endpoints

Rate limits

Credits

Clean Employee endpoints

Clean Employee API features two search and two collect endpoints. Use the endpoints with any API-compatible application to retrieve Clean Employee data.

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

Clean data API supports two types of requests:

• Search endpoints support POST requests only.

• Collect endpoints support the GET requests only.

Endpoint	Function	Credits
POST /v2/employee_clean/search/es_dsl	Search for relevant employee profiles using Elasticsearch DSL schema	Free
POST /v2/employee_clean/search/es_dsl/preview	Retrieves a small set of partial data using Elasticsearch queries	10
GET /v2/employee_clean/collect/{employee_id}	Collect employee data using IDs	10
GET /v2/employee_clean/collect/{profile_url/shorthand_name}	Collect Clean 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

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

Request type	Endpoint and function
POST	/v2/data_requests/employee_clean/id_file
POST	/v2/data_requests/employee_clean/es_dsl
POST	/v2/data_requests/employee_clean/shorthand_names
POST	/v2/data_requests/employee_clean/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 in employee data:

Request type	Endpoint
POST	/v2/subscriptions/employee_clean/es_dsl
POST	/v2/subscriptions/employee_clean/ids

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

Request type	Endpoint
POST	/v2/subscriptions/experience_changes/employee_clean/es_dsl
POST	/v2/subscriptions/experience_changes/employee_clean/ids
POST	/v2/subscriptions/experience_changes/employee_clean/all

Learn more about Webhook subscriptions