GET Requests

12min
Overview
Send a GET request to each of the specified GET endpoints to retrieve employee data in bulk:
Make a query in the /v1/bulk_collect/{data_request_id}/files endpoint to see the status of your data request. Collect the file name to use further. 
Collect the data request ID and the file name. Make a query in the /v1/bulk_collect/{data_request_id}/files/{file_name} endpoint and download the job posting data in a json.gz file.  
﻿Response codes﻿
See the list of possible error codes. 
You can download the prepared dataset as many times as you like within 30 days of the query submission.
﻿
Instructions
GET the file name
Send a GET request to the endpoint /v1/bulk_collect/{data_request_id}/files to see the status of your data request. 
Collect the file name for further usage in request to the /v1/bulk_collect/{data_request_id}/files/{file_name} endpoint.
Endpoint usage
Take the data request ID (obtained from any of the job POST endpoints).
Paste it in the following cURL request instead of {request_id}:
Request body template
curl -X 'GET' \
'https://api.coresignal.com/cdapi/v1/bulk_collect/{request_id}/files' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {JWT}'
curl -X 'GET' \
'https://api.coresignal.com/cdapi/v1/bulk_collect/{request_id}/files' \
-H 'accept: application/json' \
-H 'Authorization: Bearer {JWT}'
﻿
Paste your Company API token instead of {JWT}.
Import the cURL request to any API-compatible application. 
Send the request. 
If you do not see a file name, the data request is not ready. Send the request again until you can see the file name. 
Retrieve the file name. 
File name
{
  "data_request_files": [
    "part-00000-2c3d41c2-99c2-43ff-a39c-7ad7h63h7cd9-h000.json.gz"
  ]
}
{
  "data_request_files": [
    "part-00000-2c3d41c2-99c2-43ff-a39c-7ad7h63h7cd9-h000.json.gz"
  ]
}
﻿
Each JSON.gz file contains a maximum of 10,000 JSON records. 
If you submitted more than 10,000 IDs or your filter request returned more than 10,000 profiles, you will see several file names. 
Insufficient credits
The following message indicates that your query is too expensive. 
Insufficient credits
{
    "detail": "Insufficient credits"
}
{
    "detail": "Insufficient credits"
}
﻿
Try adding "limit": {integer}parameter to your query.
﻿
GET the file
Request downloadable files by making a GET request to the  /v1/bulk_collect/{data_request_id}/files/{file_name} endpoint. 
Endpoint usage
Paste the data request ID and file name in the following template:
Request body template
curl -X 'GET' \
'https://api.coresignal.com/cdapi/v1/bulk_collect/{request_id}/files/{file_name}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}'
curl -X 'GET' \
'https://api.coresignal.com/cdapi/v1/bulk_collect/{request_id}/files/{file_name}' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer {JWT}'
﻿
The data request ID is obtained via the POST requests. 
The file name is obtained using the data request ID in the  /v1/bulk_collect/{data_request_id}/files endpoint.
Insert your Company API token instead of {JWT}.
Import the cURL to any API-compatible application.
If you use Postman, click the arrow down and select Send and Download:
﻿
Check for similar methods to retrieve the file using other API-compatible applications.
Updated 08 Sep 2024
Did this page help you?
POST Requests
Request Examples
GET Requests

Overview

﻿Response codes﻿

Instructions

GET the file name

Endpoint usage

Insufficient credits

GET the file

Endpoint usage

Response codes
