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

Request types

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.

Request type	Endpoint	Function
POST	/v2/employee_clean/search/es_dsl	Search for relevant employee profiles using Elasticsearch DSL schema
POST	/v2/employee_clean/search/es_dsl/preview	Retrieves a small set of partial data using Elasticsearch queries
GET	/v2/employee_clean/collect/{employee_id}	Collect employee data using IDs
GET	/v2/employee_clean/collect/{shorthand_name}	Collect employee data using shorthand names*

*📌 Full profile URL example: www.professional-network.com/in/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}

Webhook subscriptions

Webhook subscription feature allows you to set up subscriptions and be notified of work experience changes in selected employee profiles.

Use the following endpoints to subscribe to changes in employee data:

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

Learn more about Webhook subscriptions

Request types

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.

Request type	Endpoint and function
POST	/v2/employee_clean/search/es_dsl
POST	/v2/employee_clean/search/es_dsl/preview
GET	/v2/employee_clean/collect/{employee_id}
GET	/v2/employee_clean/collect/{shorthand_name}

Rate limits

Clean Employee API endpoints restrict the 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

One search credit is deducted for one successful (200) request in the search endpoints:

• /v2/employee_clean/search/es_dsl

• /v2/employee_clean/search/es_dsl/preview

One collect credit is deducted for one successful (200) request in the collection endpoints:

• /v2/employee_clean/collect/{employee_id}

• /v2/employee_clean/collect/{shorthand_name}

Remember that making one Bulk Collect request will consume more credits as you get bigger data batches.

---

Read more about the credits in the following topic:

General information about credits