POST requests

overview bulk collect features three post endpoints, making collecting employee data records in bulk easier before you proceed with your bulkapi requests, test them in the clean data 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 post requests docid\ w4l57jlca9itm7gluol3t request employee data using an elasticsearch query post requests docid\ w4l57jlca9itm7gluol3t request employee data by submitting a list of ids post requests using elasticsearch schema use the endpoint /v2/data requests/employee clean/es dsl to request employee data in bulk using our elasticsearch dsl schema use the clean employee elasticsearch dsl to compile the request endpoint usage prepare your request using the following template add select filters and your webhook url to the template request body template curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/employee clean/es dsl' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "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 clean/es dsl' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "webhook url" "{optional webhook url}", "limit" {optional integer}, "query" { "bool" { "should" \[ { "query string" { "query" "python", "default field" "description", "default operator" "and" } }, { "query string" { "query" "python", "default field" "job title", "default operator" "and" } }, { "nested" { "path" "experience", "query" { "bool" { "should" \[ { "query string" { "query" "python", "default field" "experience description", "default operator" "and" } }, { "query string" { "query" "python", "default field" "experience title", "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" "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 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 member profile data post requests using ids use the endpoint /v2/data requests/employee clean/id file to submit a list of ids in a csv or txt file to request employee data in bulk check the example for the id list formatting https //archbee doc uploads s3 amazonaws com/inaodshbfav9t72jx5jdm/cjdkl0wlyb3kqdqsix8fj idlistexample csv endpoint usage prepare the ids file in a csv or txt format make sure the list only contains numeric ids avoid any additional headings in the file the request will fail if non numeric data is present in the file paste in your api key instead of {api key} and, optionally, webhook url in the curl request template curl request curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/employee clean/id file' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type multipart/form data' \\ f 'ids file=@id list example csv;type=text/csv' \\ f 'data format=json' \\ f 'webhook url={optional webhook url}' import the edited curl request to postman or any other api compatible application further instructions are for the post requests using postman click body click select files to upload the ids file 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 location /v2/data requests/e000b0ec 0f00 0b00 0a0a 0b00fa0000d0/files 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 clean/shorthand names' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "webhook url" "{optional webhook url}", "shorthand names" \[] }' request body template for urls curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/employee clean/urls' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "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 clean/shorthand names' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "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 clean/urls' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "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 location /v2/data requests/e000b0ec 0f00 0b00 0a0a 0b00fa0000d0/files 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\ cudq9fvnuysab0mdjgscb detailed information on how to retrieve the file name get requests docid\ cudq9fvnuysab0mdjgscb in depth instructions on how to download the data file