Company API
Endpoints
Bulk Collect
POST Requests

24min
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﻿
Request company data using a search filter query. 
﻿Elasticsearch POST requests﻿
Request company data using an Elasticsearch query. 
﻿ID POST requests﻿
Request company data by submitting a list of IDs.
Search POST requests
﻿Response codes﻿
See the list of possible error codes. 
Use the endpoint /v1/professional_network/company/bulk_collect/filter to request company data in bulk using search filters:
Search endpoint filters
{
  "name": "string",
  "website": "string",
  "exact_website": "string",
  "size": "string",
  "industry": "string",
  "country": "string",
  "location": "string",
  "created_at_gte": "string",
  "created_at_lte": "string",
  "last_updated_gte": "string",
  "last_updated_lte": "string",
  "employees_count_gte": 0,
  "employees_count_lte": 0,
  "source_id": 0,
  "founded_year_gte": 0,
  "founded_year_lte": 0,
  "funding_total_rounds_count_gte": 0,
  "funding_total_rounds_count_lte": 0,
  "funding_last_round_type": "string",
  "funding_last_round_date_gte": "string",
  "funding_last_round_date_lte": "string"
}
{
  "name": "string",
  "website": "string",
  "exact_website": "string",
  "size": "string",
  "industry": "string",
  "country": "string",
  "location": "string",
  "created_at_gte": "string",
  "created_at_lte": "string",
  "last_updated_gte": "string",
  "last_updated_lte": "string",
  "employees_count_gte": 0,
  "employees_count_lte": 0,
  "source_id": 0,
  "founded_year_gte": 0,
  "founded_year_lte": 0,
  "funding_total_rounds_count_gte": 0,
  "funding_total_rounds_count_lte": 0,
  "funding_last_round_type": "string",
  "funding_last_round_date_gte": "string",
  "funding_last_round_date_lte": "string"
}
﻿
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/v1/professional_network/company/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
   "data_format": "json",
   "limit": {optional_integer},
   "webhook_url": "{optional_webhook_url}",
   "filters": {}
}'
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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.
Example request
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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"
              }
   }'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/filter' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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 Company API token instead of {JWT}.
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"
}
{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}
﻿
 Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints to retrieve the company profile data. 
﻿
Elasticsearch POST requests
﻿Response codes﻿
See the list of possible error codes. 
Use the endpoint /v1/professional_network/company/bulk_collect/es_dsl to request company data in bulk using our Elasticsearch DSL schema:
Elasticsearch schema
{
	"mappings": {
		"properties": {
			"id": {
				"type": "long"
			},
			"url": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword"
					}
				}
			},
			"name": {
				"type": "text"
			},
			"website": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword",
						"null_value": "NULL"
					},
					"filter": {
						"type": "text"
					}
				}
			},
			"size": {
				"type": "keyword",
				"null_value": "NULL"
			},
			"industry": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword",
						"null_value": "NULL"
					}
				}
			},
			"description": {
				"type": "text"
			},
			"founded": {
				"type": "date",
				"format": "uuuu"
			},
			"headquarters_country_parsed": {
				"type": "keyword",
				"null_value": "NULL"
			},
			"headquarters_new_address": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword",
						"null_value": "NULL"
					}
				}
			},
			"source_id": {
				"type": "long"
			},
			"created": {
				"type": "date",
				"format": "yyyy-MM-dd HH:mm:ss"
			},
			"last_updated": {
				"type": "date",
				"format": "yyyy-MM-dd HH:mm:ss"
			},
			"type": {
				"type": "text"
			},
			"employees_count": {
				"type": "long",
				"null_value": -1
			},
			"shorthand_name": {
				"type": "keyword"
			},
			"canonical_url": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword"
					}
				}
			},
			"canonical_shorthand_name": {
				"type": "keyword"
			},
			"deleted": {
				"type": "byte"
			},
			"company_crunchbase_info_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"cb_url": {
						"type": "text",
						"fields": {
							"exact": {
								"type": "keyword"
							}
						}
					}
				}
			},
			"company_specialties_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"specialty": {
						"type": "text"
					}
				}
			},
			"company_stock_info_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"ticker": {
						"type": "text"
					}
				}
			},
			"company_funding_rounds_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"last_round_investors_count": {
						"type": "long"
					},
					"total_rounds_count": {
						"type": "long",
						"null_value": -1
					},
					"last_round_type": {
						"type": "keyword"
					},
					"last_round_date": {
						"type": "date",
						"format": "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||uuuu",
						"null_value": "1000"
					},
					"last_round_money_raised": {
						"type": "keyword"
					},
					"cb_url": {
						"type": "keyword"
					},
					"created": {
						"type": "date",
						"format": "yyyy-MM-dd HH:mm:ss"
					},
					"last_updated": {
						"type": "date",
						"format": "yyyy-MM-dd HH:mm:ss"
					},
					"deleted": {
						"type": "byte"
					}
				}
			}
		}
	}
}
{
	"mappings": {
		"properties": {
			"id": {
				"type": "long"
			},
			"url": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword"
					}
				}
			},
			"name": {
				"type": "text"
			},
			"website": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword",
						"null_value": "NULL"
					},
					"filter": {
						"type": "text"
					}
				}
			},
			"size": {
				"type": "keyword",
				"null_value": "NULL"
			},
			"industry": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword",
						"null_value": "NULL"
					}
				}
			},
			"description": {
				"type": "text"
			},
			"founded": {
				"type": "date",
				"format": "uuuu"
			},
			"headquarters_country_parsed": {
				"type": "keyword",
				"null_value": "NULL"
			},
			"headquarters_new_address": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword",
						"null_value": "NULL"
					}
				}
			},
			"source_id": {
				"type": "long"
			},
			"created": {
				"type": "date",
				"format": "yyyy-MM-dd HH:mm:ss"
			},
			"last_updated": {
				"type": "date",
				"format": "yyyy-MM-dd HH:mm:ss"
			},
			"type": {
				"type": "text"
			},
			"employees_count": {
				"type": "long",
				"null_value": -1
			},
			"shorthand_name": {
				"type": "keyword"
			},
			"canonical_url": {
				"type": "text",
				"fields": {
					"exact": {
						"type": "keyword"
					}
				}
			},
			"canonical_shorthand_name": {
				"type": "keyword"
			},
			"deleted": {
				"type": "byte"
			},
			"company_crunchbase_info_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"cb_url": {
						"type": "text",
						"fields": {
							"exact": {
								"type": "keyword"
							}
						}
					}
				}
			},
			"company_specialties_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"specialty": {
						"type": "text"
					}
				}
			},
			"company_stock_info_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"ticker": {
						"type": "text"
					}
				}
			},
			"company_funding_rounds_collection": {
				"type": "nested",
				"properties": {
					"id": {
						"type": "long"
					},
					"last_round_investors_count": {
						"type": "long"
					},
					"total_rounds_count": {
						"type": "long",
						"null_value": -1
					},
					"last_round_type": {
						"type": "keyword"
					},
					"last_round_date": {
						"type": "date",
						"format": "yyyy-MM-dd HH:mm:ss||yyyy-MM-dd||uuuu",
						"null_value": "1000"
					},
					"last_round_money_raised": {
						"type": "keyword"
					},
					"cb_url": {
						"type": "keyword"
					},
					"created": {
						"type": "date",
						"format": "yyyy-MM-dd HH:mm:ss"
					},
					"last_updated": {
						"type": "date",
						"format": "yyyy-MM-dd HH:mm:ss"
					},
					"deleted": {
						"type": "byte"
					}
				}
			}
		}
	}
}
﻿
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/v1/professional_network/company/bulk_collect/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -H 'Content-Type: application/json' \
  -d '{
  "data_format": "json",
  "webhook_url": "{optional_webhook_url}",
  "limit": {optional_integer},
  "es_dsl_query": {}
  }'
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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.
Example request
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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"
               }
            }
         ]
      }
   }
 }
  }'
curl -X 'POST' \
'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/es_dsl' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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 Company API token instead of {JWT}.
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"
}
{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}
﻿
Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints to retrieve the company profile data.
﻿
ID POST requests
﻿Response codes﻿
See the list of possible error codes. 
Use the endpoint /v1/professional_network/company/bulk_collect/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:
id_list_example.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 JWT token instead of {JWT} and, optionally, webhook URL in the cURL request template:
cURL request
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/id_file' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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}'
curl -X 'POST' \
  'https://api.coresignal.com/cdapi/v1/professional_network/company/bulk_collect/id_file' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}' \
  -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"
}
{
  "request_id": "433869ec-0a98-4dcd-9b13-db4df58260f5"
}
﻿
Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints.
﻿
Following steps
Make a GET request using v1/bulk_collect/{data_request_id}/files. Retrieve the data file name. 
Use /v1/bulk_collect/{data_request_id}/files/{file_name} endpoint to download the JSON data using the request ID and file name.
﻿GET the file name﻿
Detailed information on how to retrieve the file name. 
﻿GET the file﻿
In-depth instructions on how to download the data file. 
﻿
Updated 08 Sep 2024
Did this page help you?
Bulk Collect
GET Requests
POST Requests

Overview

Choose the POST request that fits you the best

Search POST requests

Elasticsearch POST requests

ID POST requests

Search POST requests

Response codes

Search endpoint filters

Endpoint usage

Request example

Elasticsearch POST requests

Response codes

Elasticsearch schema

Endpoint usage

Request example

ID POST requests

Response codes

Endpoint usage

Following steps

GET the file name

GET the file

POST Requests

Overview

Choose the POST request that fits you the best

﻿Search POST requests﻿

﻿Elasticsearch POST requests﻿

﻿ID POST requests﻿

Search POST requests

﻿Response codes﻿

Search endpoint filters

Endpoint usage

Request example

Elasticsearch POST requests

﻿Response codes﻿

Elasticsearch schema

Endpoint usage

Request example

ID POST requests

﻿Response codes﻿

Endpoint usage

Following steps

﻿GET the file name﻿

﻿GET the file﻿

Search POST requests

Elasticsearch POST requests

ID POST requests

Response codes

Response codes

Response codes

GET the file name

GET the file
