Employee API
Employee API will be deprecated on August 6th. Until then, you must transfer to a Base Employee API . Read all about the benefits and changes here.
This section covers general details about Employee API. Follow the links inside the topics to learn more about the API and its endpoints.
START NOW
All new users can test data quality with free API Search and Collect credits. After the trial, users can select an API subscription plan based on their business needs.
Subscription plans start at just $49/month. No credit card required.
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 | /v1/professional_network/employee/search/filter | Search for relevant employee profiles using search filters |
POST | /v1/professional_network/employee/search/es_dsl | Search for relevant employee profiles using Elasticsearch DSL schema |
GET | /v1/professional_network/employee/collect/{employee_id} | Collect employee data using IDs |
GET | /v1/professional_network/employee/collect/ {shorthand_name} | 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. You can also get the token from Coresignal's self-service platform.
All requests to the Employee API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).
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.
Every search and collect response contains an X-Credits-Remaining header that shows the number of credits left in your account.
You can find the credit balance by clicking Headers in Postman.
Example of remaining credits header:
Explore what data points we offer in our API employee data: