Employee Data

Base Employee API

12min

This section covers basic information about Base Employee API.
To learn more about the API and its endpoints, follow the links below:
﻿Base Employee API endpoints﻿ 
Find information about Base Employee API endpoints. 
﻿Request types﻿ 
Information about available request types.
﻿Rate limits﻿ 
Information about available rate limits. 
﻿Authorization﻿ 
Authorization flow in the API.
﻿Credits and tokens﻿ 
Information about API credits and tokens.
Base Employee API endpoints
Our API is a data retrieval tool. The endpoints do not support analytic features. 
Base Employee API features three search and two collect endpoints for searching and collecting relevant Base Employee data. 
Request type
Endpoint
POST
/v1/professional_network/employee_base/search/filter
POST
/v1/professional_network/employee_base/search/es_dsl
POST
/v1/professional_network/employee_base/map/ids
GET
/v1/professional_network/employee_base/collect/{employee_id}
GET
/v1/professional_network/employee_base/collect/{shorthand_name}
Bulk API (Bulk Collect) expands upon Base Employee API's functionality, featuring three POST and two GET endpoints. 
Request type
Endoint
POST
/v1/professional_network/employee_base/bulk_collect/ids
POST
/v1/professional_network/employee_base/bulk_collect/es_dsl
POST
/v1/professional_network/employee_base/bulk_collect/filter
GET
/v1/bulk_collect/{data_request_id}/files
GET
/v1/bulk_collect/{data_request_id}/files/{file_name}
Bulk Collect allows you to search and collect base employee data in bulk using employee IDs, search filters, or ES DSL queries. 

Read more on Bulk Collect in the following articles:
﻿Bulk Collect general information﻿ 
Read more about the function and specifications of Bulk Collect endpoints.
﻿Bulk Collect POST requests﻿ 
Follow the step-by-step guide to request base employee data in bulk. 
﻿Bulk Collect GET requests﻿ 
Follow the step-by-step guide to collect base employee data in bulk. 
Base Employee API's subscription 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:
Request type
Endpoint
POST
/v1/subscriptions/professional_network/employee_base/es_dsl
POST
/v1/subscriptions/professional_network/employee_base/filter
POST
/v1/subscriptions/professional_network/employee_base/ids
﻿Webhook Subscriptions﻿  
Get all the details you need to subscribe to be notified of employee profile changes. 
﻿Simulate a subscription﻿  
Find all the necessary information to try out the feature.
﻿Create a subscription﻿ 
Find all the necessary information to create a webhook subscription and retrieve the data.
﻿Manage your subscriptions﻿ 
Find all the necessary information for subscription management.
Request types
All Base Employee API requests must be made over HTTPS.  Requests made over HTTP will fail.
Base 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/employee_base/search/filter
Search for relevant employee profiles using search filters
POST
/v1/professional_network/employee_base/search/es_dsl
Search for relevant employee profiles using Elasticsearch DSL schema
POST
/v1/professional_network/employee_base/map/ids
IDs mapping endpoint between Employee and Base Employee APIs
GET
/v1/professional_network/employee_base/collect/{employee_id}
Collect Base Employee data using IDs
GET
/v1/professional_network/employee_base/collect/{shorthand_name}
Collect Base Employee data using shorthand names*
*📌 Full profile URL example: www.professional_network.com/in/john-doe.
Shorthand name example: john-doe.
Rate limits
Base Employee API endpoints restrict the number of requests allowed per second for each client's API token.
Base Employee API search endpoints
Base 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 representative will generate the token for you upon your request for the API plan. 
﻿
All requests to the Base Employee API must contain an Authorization header that consists of a Bearer authentication string and the JSON Web Token (JWT).
Authorization header
Authorization header
-H “Authorization: Bearer {JWT}”
-H “Authorization: Bearer {JWT}”
﻿
Python
Ruby
Node.js
PHP
import requests

api_endpoint = "API_ENDPOINT"
jwt_token = "JWT_TOKEN"

headers = {
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)
import requests

api_endpoint = "API_ENDPOINT"
jwt_token = "JWT_TOKEN"

headers = {
    "Authorization": f"Bearer {jwt_token}"
}

response = requests.get(api_endpoint, headers=headers)

# Print the response content or handle it as needed
print(response.text)
﻿
Use any API-compatible tool to authorize and start querying in the API.
If you're unsure where to begin, follow the authorization tutorials:
﻿Authorization﻿ 
Credits and tokens
The token issued for you has a set amount of search and collect credits.
One search credits are deducted for one successful (200) request in the search endpoint:
/v1/professional_network/employee_base/search/filter
/v1/professional_network/employee_base/search/es_dsl
/v1/professional_network/employee_base/map/ids
﻿
One collection credits are deducted for one successful (200) request in the collection endpoints:
/v1/professional_network/employee_base/collect/{employee_id}
/v1/professional_network/employee_base/collect/{shorthand_name}
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 the Postman application.
﻿
Example of remaining credits header:
JSON
x-credits-remaining: 9973
x-credits-remaining: 9973
﻿
Data dictionary and samples
Explore data points in API base employee data:
﻿Data Dictionary: Base Employee API﻿ 
﻿Sample: Base Employee API﻿ 
﻿

Request type	Endpoint
POST	/v1/professional_network/employee_base/search/filter
POST	/v1/professional_network/employee_base/search/es_dsl
POST	/v1/professional_network/employee_base/map/ids
GET	/v1/professional_network/employee_base/collect/{employee_id}
GET	/v1/professional_network/employee_base/collect/{shorthand_name}

Request type	Endoint
POST	/v1/professional_network/employee_base/bulk_collect/ids
POST	/v1/professional_network/employee_base/bulk_collect/es_dsl
POST	/v1/professional_network/employee_base/bulk_collect/filter
GET	/v1/bulk_collect/{data_request_id}/files
GET	/v1/bulk_collect/{data_request_id}/files/{file_name}

Request type	Endpoint
POST	/v1/subscriptions/professional_network/employee_base/es_dsl
POST	/v1/subscriptions/professional_network/employee_base/filter
POST	/v1/subscriptions/professional_network/employee_base/ids

Request type	Endpoint	Function
POST	/v1/professional_network/employee_base/search/filter	Search for relevant employee profiles using search filters
POST	/v1/professional_network/employee_base/search/es_dsl	Search for relevant employee profiles using Elasticsearch DSL schema
POST	/v1/professional_network/employee_base/map/ids	IDs mapping endpoint between Employee and Base Employee APIs
GET	/v1/professional_network/employee_base/collect/{employee_id}	Collect Base Employee data using IDs
GET	/v1/professional_network/employee_base/collect/{shorthand_name}	Collect Base Employee data using shorthand names*

Subscription Management

Data Dictionary: Base Employee API

Base Employee API

Overview

Base Employee API endpoints

Request types

Rate limits

Authorization

Credits and tokens

Base Employee API endpoints

Bulk Collect

Bulk Collect general information

Bulk Collect POST requests

Bulk Collect GET requests

Webhook subscriptions

Webhook Subscriptions

Simulate a subscription

Create a subscription

Manage your subscriptions

Request types

Rate limits

Authorization

General authorization examples

Authorization

Credits and tokens

Where can I see my credit balance?

Data dictionary and samples

Data Dictionary: Base Employee API

Sample: Base Employee API

Base Employee API

Overview

﻿Base Employee API endpoints﻿

﻿Request types﻿

﻿Rate limits﻿

﻿Authorization﻿

﻿Credits and tokens﻿

Base Employee API endpoints

Bulk Collect

﻿Bulk Collect general information﻿

﻿Bulk Collect POST requests﻿

﻿Bulk Collect GET requests﻿

Webhook subscriptions

﻿Webhook Subscriptions﻿

﻿Simulate a subscription﻿

﻿Create a subscription﻿

﻿Manage your subscriptions﻿

Request types

Rate limits

Authorization

General authorization examples

﻿Authorization﻿

Credits and tokens

Where can I see my credit balance?

Data dictionary and samples

﻿Data Dictionary: Base Employee API﻿

﻿Sample: Base Employee API﻿

Base Employee API endpoints

Request types

Rate limits

Authorization

Credits and tokens

Bulk Collect general information

Bulk Collect POST requests

Bulk Collect GET requests

Webhook Subscriptions

Simulate a subscription

Create a subscription

Manage your subscriptions

Authorization

Data Dictionary: Base Employee API

Sample: Base Employee API