Employee API
Our API is a data retrieval tool. The endpoints do not support analytic features.
Employee API features two search and two collect endpoints. Use the endpoints with any API-compatible application to retrieve Professional Network Employee data.
Endpoint and function |
---|
/v1/professional_network/employee/search/filter [POST] |
/v1/professional_network/employee/search/es_dsl [POST] |
/v1/professional_network/employee/collect/{employee_id} [GET] |
/v1/professional_network/employee/collect/{shorthand_name} [GET] |
All Employee API requests must be made over HTTPS. Requests made over HTTP will fail.
Employee API supports two types of requests:
- Search endpoints support POST HTTP requests only.
- Collect endpoints support the GET HTTP requests only.
Request type | Endpoint | Function |
---|---|---|
POST | Search for relevant employee profiles using search filters | |
POST | Search for relevant employee profiles using Elasticsearch DSL schema | |
GET | Collect employee data using IDs | |
GET | Collect employee data using shorthand names* |
*📌 Full profile URL example: www.professional-network.com/john-doe. Shorthand name example: john-doe.
All personal information mentioned within this context is entirely fictional and is solely intended for illustrative purposes.
Employee API endpoints restrict the number of requests allowed per second for each client's API token.
Employee API search endpoints
Employee API collection endpoints
Bulk API POST endpoints
Bulk API GET endpoints
Allow 18 requests per second.
Allow 54 requests per second.
Allow 27 requests per second.
Allow 27 requests per second.
To start using our API, you need a (JWT) token. Your account manager or sales will generate the token for you upon your request for the API plan.
All requests to the Employee 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 querying in the API.
If you're unsure where to begin, check out the cURL authorization tutorial:
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/employee/search/filter
- /v1/professional_network/employee/search/es_dsl
One collect credit is deducted for one successful (200) request in the collection endpoints:
- /v1/professional_network/employee/collect/{employee_id}
- /v1/professional_network/employee/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 API employee data: