POST Requests

overview bulk collect features three post endpoints, making collecting company data records in bulk easier before you proceed with your bulk collect requests, test them in the clean company 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 /#elasticsearch post requests request company data using an elasticsearch query post requests /#id post requests request company data by submitting a list of ids elasticsearch post requests elasticsearch dsl docid\ bmr0bifvigi57qahh3bnx see elasticsearch schema use the endpoint /v2/data requests/company clean/es dsl to request company data in bulk using our elasticsearch dsl schema 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/company clean/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/company clean/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" { "query" { "bool" { "must" \[ { "query string" { "query" "2023", "default field" "founded", "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 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 company profile data id post requests use the endpoint /v2/data requests/company clean/ids to submit a list of ids to request company data in bulk endpoint usage prepare the ids list make sure the list only contains numeric ids enter 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/company clean/ids' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type multipart/form data' \\ d '{ "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/company clean/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/company clean/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/company clean/shorthand names' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{optional webhook url}", "shorthand names" \[ "example company", "company1", "example corp" ] }' example request for urls curl x 'post' \\ 'https //api coresignal com/cdapi/v2/data requests/company clean/urls' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "webhook url" "{optional webhook url}", "urls" \[ "https //www linkedin com/in/example company", "https //www linkedin com/in/company1", "https //www linkedin com/in/example corp" ] }' 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 5lulh8qjly3volzrftrtu detailed information on how to retrieve the file name get requests docid 5lulh8qjly3volzrftrtu in depth instructions on how to download the data file