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 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 search post requests https //docs coresignal com/api/bulk collect companies post#v0zjf request company data using a search filter query elasticsearch post requests https //docs coresignal com/api/bulk collect companies post#scvx3 request company data using an elasticsearch query id post requests https //docs coresignal com/api/bulk collect companies post#az4vy request company data by submitting a list of ids search post requests use the endpoint /v2/data requests/company base/filter to request company data in bulk using search filters search filters docid\ cn6idgglbqvdbsu9x79js 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/company base/filter' \\ h 'accept application/json' \\ h 'apikey {api key}' \\ h 'content type application/json' \\ d '{ "data format" "json", "limit" {optional integer}, "webhook url" "{optional webhook url}", "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/company base/filter' \\ 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}, "filters" { "industry" "information technology", "created at gte" "2018 01 01 00 00 01", "last updated gte" "2022 05 26 00 00 01" } }' 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" "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 company profile data elasticsearch post requests use the endpoint /v2/data requests/company base/es dsl to request company data in bulk using our elasticsearch dsl schema elasticsearch dsl docid\ bcv2ttrqsz5iyuhfhstcd 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 base/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/company base/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" { "query" { "bool" { "must" \[ { "query string" { "query" "(3d printing) or (3d printing service) or (lead generation)", "default field" "description", "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 company profile data id post requests use the endpoint /v2/data requests/company base/id file to submit a list of ids in a csv or txt file to request company data in bulk check the example for the id list formatting https //archbee doc uploads s3 amazonaws com/inaodshbfav9t72jx5jdm/j mldmcd3fk5fmu7fzokq 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 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 base/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 upload the ids file by clicking the select files button in the value column 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 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 the file name https //docs coresignal com/api/bulk collect companies get#zn80s detailed information on how to retrieve the file name get the file https //docs coresignal com/api/bulk collect companies get#e4ouk in depth instructions on how to download the data file