EndpointsAPI

Export loads to CSV

Export every load matching the load board’s search, filters, selected tab, and sort order. The CSV contains one row per load and is not limited by the board’s current page.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

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

Headers

X-Organization-IDstring or nullOptional

Query parameters

searchstring or nullOptional
statuslist of enums or nullOptional
tms_statuslist of strings or nullOptional
is_postedboolean or nullOptional
modelist of enums or nullOptional
equipment_typelist of enums or nullOptional
customer_namelist of strings or nullOptional
carrier_rep_namelist of strings or nullOptional
origin_citystring or nullOptional
destination_citystring or nullOptional
pickup_date_fromdate or nullOptional
pickup_date_todate or nullOptional
delivery_date_fromdate or nullOptional
delivery_date_todate or nullOptional
created_at_fromdate or nullOptional
created_at_todate or nullOptional
updated_at_fromdate or nullOptional
updated_at_todate or nullOptional
last_posted_at_fromdate or nullOptional

Earliest UTC calendar day (inclusive) on which Envoy’s posted flag last turned on

last_posted_at_todate or nullOptional

Latest UTC calendar day (inclusive) on which Envoy’s posted flag last turned on

distance_mindouble or nullOptional>=0
distance_maxdouble or nullOptional>=0
posted_rate_mininteger or nullOptional>=0
posted_rate_maxinteger or nullOptional>=0
tabenum or nullOptional
Tab filter used by the loads list view. Each value maps to an existence-subquery condition applied on top of the standard load filters. ``ALL`` is the no-op default. ``ACTIVE_ESCALATIONS`` is reserved for an upcoming product workflow; the API surfaces it so the front-end can render the full tab strip from day one, but the backend returns 0 / no rows until the feature lands.
view_idstring or nullOptionalformat: "uuid"

A saved load view to apply (ENG-2112). Its filters stack under the inline ones: both narrow, neither widens. 404 when the view is not visible to the caller.

order_bystringOptionalDefaults to created_at
order_descbooleanOptionalDefaults to true

Response

CSV download

Errors

401
Unauthorized Error
403
Forbidden Error
422
Unprocessable Entity Error
429
Too Many Requests Error