Skip to main content
GET
/
carrier
/
files
List Carrier Files
curl --request GET \
  --url https://production.trackstarhq.com/carrier/files \
  --header 'x-trackstar-access-token: <x-trackstar-access-token>' \
  --header 'x-trackstar-api-key: <x-trackstar-api-key>'
{
  "data": [
    {
      "filename": "invoice.csv",
      "generated_time": "2023-11-07T05:31:56Z",
      "file_type": "csv",
      "download_url": "https://s3.amazonaws.com/...",
      "download_url_expires_at": "2025-01-15T10:50:00Z"
    }
  ],
  "total_count": 45,
  "next_token": "base64_token"
}

Headers

​
x-trackstar-api-key
string
required

Your organization-level Trackstar API key.

Example:

"<x-trackstar-api-key>"

​
x-trackstar-access-token
string
required

Your user's access token for a specific integration (ShipHero, Extensiv, etc).

Example:

"<x-trackstar-access-token>"

Query Parameters

​
start_time
string<date-time>

Filter by the time Trackstar generated the file in ISO Format. Defaults to 24 hours ago.

​
end_time
string<date-time>

Filter by the time Trackstar generated the file in ISO Format. Defaults to current time.

​
limit
integer
default:100

Maximum number of files to return (max 1000).

Example:

0

​
page_token
string

Token for paginating results.

​
file_type
string

Filter by file type (e.g., csv, pdf).

Example:

"csv"

Response

Successful response

​
data
CarrierFile · object[]
required

List of carrier files

​
total_count
integer
required

Number of files in current page.

Example:

45

​
next_token
string
required

Token for next page, null if no more results.

Example:

"base64_token"