Skip to main content
POST
/
v1
/
bulk_downloads
Bulk download FileAttachments
curl --request POST \
  --url https://api.tread-horizon.com/v1/bulk_downloads \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Accept-Language
string
default:en

The Accept-Language request HTTP header indicates the natural language and locale that the client prefers.

Example:

"en"

Body

application/json
​
type
enum<string>
required
Available options:
pdf,
zip
​
job_ids
string<uuid>[]
​
filter
object

Response

Accepted

​
data
BulkDownload-Read · object
required