POST Requests: Base Employee API

Data type:

URLs:

Base Employee

https://api.coresignal.com/cdapi/v2/data_requests/employee_base/filter https://api.coresignal.com/cdapi/v2/data_requests/employee_base/es_dsl https://api.coresignal.com/cdapi/v2/data_requests/employee_base/ids https://api.coresignal.com/cdapi/v2/data_requests/employee_base/shorthand_names https://api.coresignal.com/cdapi/v2/data_requests/employee_base/urls

---

Overview

Bulk Collect features three POST endpoints, making collecting employee data records in bulk easier.

Before you proceed with your Bulk Collect requests, test them in the Base Employee API first to avoid any unexpected costs.

Find step-by-step guides for making Bulk Collect POST requests in the following topic:

Bulk Collect POST requests guides

Search filter requests

Use the endpoint /v2/data_requests/employee_base/filter to request several employee profiles using our regular search endpoint filters.

Base Employee API Search filters list

Endpoint usage example

Example request

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/filter' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{optional_webhook_url}",
   "limit": {optional_integer},
   "filters": {
      "headline": "CSO",
      "location": "United States",
      "industry": "Information Technology"
      }
   }'

• Retrieve the request ID from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

Elasticsearch DSL requests

Use the endpoint /v2/data_requests/employee_base/es_dsl to request employee data in bulk using our Elasticsearch DSL schema:

Base Company API Elasticsearch DSL schema

Endpoint usage example

When creating a new Bulk Collect request based on an Elasticsearch DSL query to the Base Employee endpoint, it is recommended to include the following clause in the query. 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.

    "term": {
        "is_parent": 1
    }

Example request

curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/es_dsl' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
  "limit": {optional_integer},
  "webhook_url": "{optional_webhook_url}",
  "es_dsl_query": {
   "query":{
      "bool":{
         "must":[
            {
               "match":{
                  "title":{
                     "query":"Developer",
                     "operator":"and"
                  }
               }
            },
            {
               "match":{
                  "location":{
                     "query":"United States",
                     "operator":"and"
                  }
               }
            },
            {
               "nested":{
                  "path":"member_experience_collection",
                  "query":{
                     "bool":{
                        "must":[
                           {
                              "query_string":{
                                 "query":"Microsoft",
                                 "default_field":"member_experience_collection.company_name",
                                 "default_operator":"and"
                              }
                           }
                        ]
                     }
                  }
               }
            }
         ]
      }
   }
}'

• Retrieve the request ID from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

IDs requests

Use the endpoint /v2/data_requests/employee_base/ids to submit a list of IDs to request employee data in bulk. Check the example for the ID list formatting:

Endpoint usage example

cURL request

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/ids' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -d '{
  "limit": {optional_integer},
  "webhook_url": "{optional_webhook_url}",
  "ids": [
    1,
    222,
    3456
  ]
}'

• Retrieve the request_id from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

---

Shorthand names and URLs requests

You can send up to 10,000 shorthand_names or URLs per request. Requirements for shorthand_names are listed below:

Shorthand names requirements

Endpoint usage example

shorthand_names

Example request for shorthand_names

curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v2/data_requests/employee_base/shorthand_names' \
  -H 'accept: application/json' \
  -H 'apikey: {API Key}' \
  -H 'Content-Type: application/json' \
  -d '{
   "webhook_url": "{optional_webhook_url}",
   "shorthand_names": [
      "john-doe",
      "jane-doe",
      "john-smith"
      ]
   }'

URLs

• Retrieve the request ID from the response body:

Request ID

{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}

• Location response header provides a URL where the results can be retrieved.

Location: /v2/data_requests/e000b0ec-0f00-0b00-0a0a-0b00fa0000d0/files

Following steps

Make GET requests to download the data