Clean Employee API
Clean data API features one search and two collect endpoints. Use the endpoints with any API-compatible application to retrieve Clean Employee data.
Request type | Endpoint |
|---|---|
POST | /v1/professional_network/clean_member/search/es_dsl |
GET | /v1/professional_network/clean_member/collect/{employee_id} |
GET | /v1/professional_network/clean_member/collect/{shorthand_name} |
All Clean Employee API requests must be made over HTTPS. Requests made over HTTP will fail.
Clean 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/professional_network/clean_member/search/es_dsl | Search for relevant employee profiles using Elasticsearch DSL schema |
GET | /v1/professional_network/clean_member/collect/{employee_id} | Collect employee data using IDs |
GET | /v1/professional_network/clean_member/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.
Clean Employee API endpoints restrict the requests allowed per second for each client's API token.
Clean Employee API search endpoints
Bulk Collect endpoints
Clean Employee API collection endpoints
Allow 18 requests per second.
Allow 27 requests per second.
Allow 54 requests per second.
To start using our API, you need a (JWT) token. Your account manager or sales representative will generate the token for you upon your request for the API plan.
All requests to the Clean data API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).
Use any API-compatible tool to authorize and start using the API.
If you're unsure where to begin, check out Postman (cURL request) tutorial below:
The token issued for you has a set amount of search and collect credits.
One search credit is deducted for one successful (200) request in the search endpoints:
- /v1/professional_network/clean_member/search/filter
- /v1/professional_network/clean_member/search/es_dsl
One collect credit is deducted for one successful (200) request in the collection endpoints:
- /v1/professional_network/clean_member/collect/{member_id}
- /v1/professional_network/clean_member/collect/{shorthand_name}
Remember that making one Bulk Collect request will consume more credits as you get bigger data batches.
Discuss your credit needs with your account manager.
Explore what data points we offer in our Clean Employee data: