POST Requests
Bulk Collect features three POST endpoints, making collecting employee data records in bulk easier.
Before you proceed with your Bulk Collect requests, test them in the Employee 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.
Request employee data using a search filter query.
Request employee data using an Elasticsearch query.
Request employee data by submitting a list of IDs.
See the list of possible error codes.
Use the endpoint /v1/professional_network/employee/bulk_collect/filter to request employee data in bulk using search filters:
- 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:
Keep in mind that parameters webhook_url and limit are optional.
- Insert your Employee 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:
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 employee profile data.
See the list of possible error codes.
Use the endpoint /v1/professional_network/employee/bulk_collect/es_dsl to request employee data in bulk using our Elasticsearch DSL schema:
- 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:
Keep in mind that parameters webhook_url and limit are optional.
- Insert your Employee API token instead of {JWT}.
- Import the cURL to any API-compatible application.
- Send the request.
- Retrieve the request ID from the response body:
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 employee profile data.
See the list of possible error codes.
Use the endpoint /v1/professional_network/employee/bulk_collect/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:
- 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:
- 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:
Use the request ID in the /v1/bulk_collect/{data_request_id}/files and /v1/bulk_collect/{data_request_id}/files/{file_name} endpoints.
- 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.
Detailed information on how to retrieve the file name.
In-depth instructions on how to download the data file.