POST Requests

29 min

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 this step is important because these requests can potentially be quite expensive by doing this, you can see how many records your query will return and understand the credits the bulk collect query will require choose the post request that fits you the best post requests /#search post requests request employee data using a search filter query post requests /#elasticsearch post requests request employee data using an elasticsearch query post requests /#id post requests request employee data by submitting a list of ids search post requests use the endpoint /v2/data requests/employee base/filter to request several employee profiles using our regular search endpoint filters use the search endpoint filters to compile the request search filters docid\ tyh6bkmm2b7p5 y2r29xh endpoint usage prepare your request using the template below input required filters in the "filters" {} section input your webhook url instead of {optional webhook url} input the required number of records instead of {optional integer} by limit parameter request body template 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" {} }' keep in mind that parameters webhook url and limit are optional request 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" } }' insert your api key instead of {api key} import the prepared curl request to any api compatible application send the request retrieve the request id from the response body request id { "request id" "12345ab 6c78 9def 0g12 hi3jk45678l9" } location response header provides a url where the results can be retrieved use the request id in the /v2/data requests/{data request id}/files and /v2/data requests/{data request id}/files/{file name} endpoints to retrieve the employee data elasticsearch post requests use the endpoint / v2/data requests/employee base/es dsl to request employee data in bulk using our elasticsearch dsl schema use the elasticsearch schema to compile the request elasticsearch dsl docid\ yfre8nrflbrr2wcsgsln endpoint usage prepare your request using the template below input required es dsl filters in the "es dsl query" {} section input your webhook url instead of {optional webhook url} input the required number of records instead of {optional integer} by limit parameter request body template 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 '{ "webhook url" "{optional webhook url}", "limit" {optional integer}, "es dsl query" {} }' keep in mind that parameters webhook url and limit are optional request example 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" "company", "default field" "member experience collection company name", "default operator" "and" } } ] } } } } ] } } } }' insert your api key instead of {api key} import the curl to any api compatible application send the request retrieve the request id from the response body request id { "request id" "12345ab 6c78 9def 0g12 hi3jk45678l9" } location response header provides a url where the results can be retrieved use the request id in the /v2/data requests/{data request id}/files and /v2/data requests/{data request id}/files/{file name} endpoints to retrieve the employee data id post requests use the endpoint /v2/data requests/employee base/ids to submit a list of ids to request employee data in bulk endpoint usage enter your api key instead of {api key} and, optionally, webhook url in the curl request template prepare a list of ids 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 ] }' import the edited curl request to postman or any other api compatible application further instructions are for the post requests using postman click body send the request 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 use the request id in the /v2/data requests/{data request id}/files and /v2/data requests/{data request id}/files/{file name} endpoints 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 must not be an empty string ( "" ) must not contain capital letters must not have leading or trailing spaces ( " john doe " ) most special characters are not allowed length must be between 3 and 100 characters endpoint usage prepare your request using the template below input required data in the "shorthand names" \[] or "urls" \[] section insert your api key instead of {api key} import the curl to any api compatible application send the request request body template 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" \[] }' request body template for urls curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/employee base/urls' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{optional webhook url}", "urls" \[] }' request example 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" ] }' example request for urls curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/employee base/urls' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{optional webhook url}", "urls" \[ "https //www professional network com/in/john doe", "https //www professional network com/in/jane doe", "https //www professional network com/in/john smith" ] }' 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 following steps make a get request using /v2/data requests/{data request id}/files retrieve the data file name use /v2/data requests/{data request id}/files/{file name} endpoint to download the json data using the request id and file name get requests docid\ sxlwwtymx9hieydap5wso detailed information on how to retrieve the file name get requests docid\ sxlwwtymx9hieydap5wso in depth instructions on how to download the data file