Employee API

14min

This section covers general details about Employee API. Follow the links inside the topics to learn more about the API and its endpoints.

Employee API endpoints

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]

Bulk API (Bulk Collect) expands upon Employee API's functionality, featuring three POST and two GET endpoints.

Endpoint and function

/v1/professional_network/employee/bulk_collect/id_file [POST]

/v1/professional_network/employee/bulk_collect/filter [POST]

/v1/professional_network/employee/bulk_collect/es_dsl [POST]

/v1/bulk_collect/{data_request_id}/files [GET]

/v1/bulk_collect/{data_request_id}/files/{file_name} [GET]

Bulk Collect allows you to search and collect employee data in bulk using employee IDs, search filters, or ES DSL queries. Read more on Bulk Collect in the following articles:

Employee API's webhook feature allows you to track updates in selected profiles by setting up a callback URL to receive notifications about changes. Use the following endpoints to subscribe to changes in employee data:

Endpoint and function

/v1/subscriptions/professional_network/employee/es_dsl [POST]

/v1/subscriptions/professional_network/employee/filter [POST]

/v1/subscriptions/professional_network/employee/id_file [POST]

Request types

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.

Rate limits

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.

Authorization

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).

Authorization header
Authorization header

Python
Ruby
Node.js
PHP


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:

Credits and tokens

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.

Document image


Example of remaining credits header:

JSON


Data dictionaries and samples

Explore what data points we offer in our API employee data:





Updated 21 Oct 2024
Did this page help you?