POST requests
Data type:
URLs:
Multi-source Employee
https://api.coresignal.com/cdapi/v2/data_requests/employee_multi_source/es_dsl https://api.coresignal.com/cdapi/v2/data_requests/employee_multi_source/ids
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 Multi-source Employee API first to avoid any unexpected costs.
Find step-by-step guides for making Bulk Collect POST requests in the following topic:
Elasticsearch DSL requests
Use the endpoint /v2/data_requests/employee_multi_source/es_dsl
to request employee data in bulk using our Elasticsearch DSL schema.
Endpoint usage example
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/data_requests/employee_multi_source/es_dsl' \
-H 'accept: application/json' \
-H 'apikey: {API Key}' \
-H 'Content-Type: application/json' \
-d '{
"webhook_url": "{optional_webhook_url}",
"limit": {optional_integer},
"query":{
"match":{
"full_name":{
"query":"John Smith",
"operator":"and"
}
}
}
}'
Retrieve the request ID from the response body
{
"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_multi_source/ids
to submit a list of IDs to request employee data in bulk.
Endpoint usage example
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v2/data_requests/employee_multi_source/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": "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
Last updated
Was this helpful?