Employee Data

Base Employee API

Endpoints

Bulk Collect

13min

When creating a bulk collect data request based on ES DSL query to the new Base Employee endpoints, we strongly advise including the following clause to your query:
        "term": {
            "is_parent": 1
        }
This ensures that you get the most out of our new systematic approach to exclude duplicate records, which we can resolve with the same profile.
Bulk Collect requests' retrieved profiles limit is 10k. Requests that exceed the limit will be rejected.
﻿Endpoints﻿ 
Information about Bulk Collect functionality and endpoints. 
﻿Credits and tokens﻿ 
Information about Bulk Collect functionality and endpoints. 
﻿Authorization﻿ 
Find details about authorization in Bulk Collect. 
﻿Rate limits﻿ 
Information about the enabled API rate limits. 
﻿Response Codes﻿ 
Find information about Bulk Collect error messages. 
﻿Webhooks﻿ 
Find out how to use webhooks in Bulk Collect POST endpoints.
Endpoints
Bulk API (Bulk Collect) is an extension of Base Employee API and includes three POST and two GET endpoints. 

Collect employee data in bulk using an employee ID list, search filters, or Elasticsearch DSL schema that is already used in the Base Employee API.
Request type
Endpoint
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}
Credits and tokens
Use the same token you have received for your Base Employee API usage. 
Your credits for Base Employee API will also apply to Bulk Collect data collection requests.
The credits are deducted after making the POST request. 
The number of credits deducted from your account depends on the data records you download. For instance, collecting 100 profiles will consume 100 credits.
Test POST requests using Base Employee API to see how many credits the request will consume.
The returned record count will show how many credits will be deducted for the Bulk Collect query. 
If you don't have enough credits, the request in the /v1/bulk_collect/{data_request_id}/files endpoint will return the error 402and the following response:
Insufficient credits
{
    "detail": "Insufficient credits"
}
{
    "detail": "Insufficient credits"
}
﻿
We validate your search and Elasticsearch POST requests in Bulk Collect to prevent the submission of duplicate requests. 

If you happen to submit duplicate POST requests using search or Elasticsearch filters, you will see the following error message:
409
{
    "detail": "Identical data request is already in progress."
}
{
    "detail": "Identical data request is already in progress."
}
﻿
Limiting returned record count
Include the parameter "limit": int to control the number of records returned by your queries in /v1/professional_network/employee_base/bulk_collect/filter and /v1/professional_network/employee_base/bulk_collect/es_dsl endpoints.

This parameter is entirely optional; however, use it to make sure you don't use too many credits with your Bulk Collect queries. 
Input the exact number of records you want returned, or delete the parameter if you don't need a set limit for your request. 
Filters
ES DSL
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v1/professional_network/employee_base/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "data_format": "json",
   "webhook_url": "{optional_webhook_url}",
   "limit": {optional_integer},
   "filters": {}
}'
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v1/professional_network/employee_base/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "data_format": "json",
   "webhook_url": "{optional_webhook_url}",
   "limit": {optional_integer},
   "filters": {}
}'
﻿
Filters
ES DSL
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/professional_network/employee_base/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "data_format": "json",
  "webhook_url": "{optional_webhook_url}",
  "limit": 5,
"filters": {
      "title": "CSO",
      "location": "United States",
      "industry": "Information Technology"
      }
}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/professional_network/employee_base/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "data_format": "json",
  "webhook_url": "{optional_webhook_url}",
  "limit": 5,
"filters": {
      "title": "CSO",
      "location": "United States",
      "industry": "Information Technology"
      }
}'
﻿
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
﻿
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 Bulk Collect requests must contain an Authorization header consisting of a Bearer authentication string and the JSON Web Token (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)
﻿
All Employee API requests must be made over HTTPS.  Requests made over HTTP will fail.
Use any API-compatible tool to authorize and start using the API. 
If you're unsure where to begin, check out the authorization tutorial below:
﻿Authorization﻿ 
Rate limits
Bulk Collect endpoints have limited requests allowed per client's API token per second.
Request type
Endpoint
Rate limit
POST
/v1/professional_network/employee_base/bulk_collect/ids
27 requests per second
POST
/v1/professional_network/employee_base/bulk_collect/filter
27 requests per second
POST
/v1/professional_network/employee_base/bulk_collect/es_dsl
27 requests per second
GET
/v1/bulk_collect/{data_request_id}/files
27 requests per second
GET
/v1/bulk_collect/{data_request_id}/files/{file_name}
27 requests per second
Webhooks
POST endpoints allow you to add webhooks and get notified when your data request is ready. 
Filter template
ES DSL template
ID file cURL template
{
  "data_format": "json",
  "webhook_url": "{optional_webhook_url}",
  "filters": {}
}
{
  "data_format": "json",
  "webhook_url": "{optional_webhook_url}",
  "filters": {}
}
﻿
Keep in mind that webhook_url is optional.
Bulk Collect Requests
Check the endpoint usage tutorials in the following articles:
﻿POST Requests﻿ 
Find examples and instructions for the Bulk Collect POST requests.
﻿GET Requests﻿ 
Find examples and instructions for the Bulk Collect GET requests.
﻿

Request type	Endpoint
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	Rate limit
POST	/v1/professional_network/employee_base/bulk_collect/ids	27 requests per second
POST	/v1/professional_network/employee_base/bulk_collect/filter	27 requests per second
POST	/v1/professional_network/employee_base/bulk_collect/es_dsl	27 requests per second
GET	/v1/bulk_collect/{data_request_id}/files	27 requests per second
GET	/v1/bulk_collect/{data_request_id}/files/{file_name}	27 requests per second

Collect

POST Requests

Bulk Collect

Overview

Endpoints

Credits and tokens

Authorization

Rate limits

Response Codes

Webhooks

Endpoints

Credits and tokens

What happens if I don't have enough credits?

What happens if I submit duplicate requests?

Limiting returned record count

Where can I see my credit balance?

Authorization

Generic authorization examples

Authorization

Rate limits

Webhooks

Request body template

Bulk Collect Requests

POST Requests

GET Requests

Bulk Collect

Overview

﻿Endpoints﻿

﻿Credits and tokens﻿

﻿Authorization﻿

﻿Rate limits﻿

﻿Response Codes﻿

﻿Webhooks﻿

Endpoints

Credits and tokens

What happens if I don't have enough credits?

What happens if I submit duplicate requests?

Limiting returned record count

Where can I see my credit balance?

Authorization

Generic authorization examples

﻿Authorization﻿

Rate limits

Webhooks

Request body template

Bulk Collect Requests

﻿POST Requests﻿

﻿GET Requests﻿

Endpoints

Credits and tokens

Authorization

Rate limits

Response Codes

Webhooks

Authorization

POST Requests

GET Requests