Skip to navigation
EndpointsLoads

List loads

List loads with pagination, search, sorting, and column filters. Search matches load number, external ID, TMS load ID, carrier name, customer name, equipment type, and pickup/delivery city/state. The tab param applies one of the existence-subquery filters used by the loads-page tab strip.

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

pageintegerOptionalDefaults to 1
page_sizeintegerOptionalDefaults to 10
searchstring or nullOptional
statuslist of enums or nullOptional
tms_statuslist of strings or nullOptional

Case-insensitive exact filter by raw status received from the source TMS

is_postedboolean or nullOptional
Filter by Envoy's internal posted state
modelist of enums or nullOptional
equipment_typelist of enums or nullOptional
customer_namelist of strings or nullOptional
carrier_rep_namelist of strings or nullOptional

Case-insensitive filter by assigned Envoy rep or source-TMS sales rep name. Repeat the parameter to match any selected rep.

origin_citystring or nullOptional

Substring match on origin stop city (ILIKE)

destination_citystring or nullOptional

Substring match on destination stop city (ILIKE)

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
Inclusive load ingestion date
created_at_todate or nullOptional
Inclusive load ingestion date
updated_at_fromdate or nullOptional

Inclusive load last-updated date

updated_at_todate or nullOptional

Inclusive load last-updated date

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

Successful Response
datalist of objects
List of items for the current page
paginationobject
Pagination metadata

Errors

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