curl --request POST \
--url https://api.tread-horizon.com/v1/bulk_downloads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "pdf",
"job_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filter": {
"job": {
"states": [
"created"
],
"customer_account_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"driver_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"dropoff_site_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"foreman_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"pickup_site_ids:": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"vendor_account_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"categories": [
"Other"
]
}
}
'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}This endpoint starts a bulk download of FileAttachments.
The job_ids and filter[jobs] params are mutually exclusive and at least one of these is required.
On success the caller should subscribe to the BulkDownloadResult RTU using the id in the response.
curl --request POST \
--url https://api.tread-horizon.com/v1/bulk_downloads \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "pdf",
"job_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"filter": {
"job": {
"states": [
"created"
],
"customer_account_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"driver_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"dropoff_site_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"foreman_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"pickup_site_ids:": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"vendor_account_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"start_date": "2023-12-25",
"end_date": "2023-12-25"
},
"categories": [
"Other"
]
}
}
'{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.tread.ai/llms.txt
Use this file to discover all available pages before exploring further.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.
"en"
Accepted
Show child attributes