Skip to navigation
EndpointsLoads

Get a load

Get a single load by ID.

Authentication: Supports API key and bearer token authentication.

Authentication

AuthorizationBearer

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

Path parameters

load_idstringRequiredformat: "uuid"

Headers

X-Organization-IDstring or nullOptional

Response

Successful Response
idstringformat: "^load_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
load_numberstring
organization_idstringformat: "^org_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
equipment_typeenum

Canonical equipment types used across loads, carriers, and lane preferences.

Uses StrEnum (not the class X(str, Enum) pattern) so that str(EquipmentType.VAN) and f"{EquipmentType.VAN}" return "VAN" instead of the default Enum.__str__ of "EquipmentType.VAN". Python 3.12 does not collapse __str__/__format__ for (str, Enum) subclasses, which would silently corrupt every f-string and Jinja template that interpolates an equipment type without .value.

created_atdatetime
updated_atdatetime
tms_load_idstring or nullOptional
external_idstring or nullOptional
modeenumOptional
load_statusstring or nullOptional

Envoy’s own status for the load, mapped from tms_status: one of Created, Unassigned, Quotes Received, Dispatched, En Route, Delivered, Cancelled, Exception. Only Created, Unassigned and Quotes Received loads are worked by the AI agent.

tms_statusstring or nullOptional
weightdouble or nullOptional
distancedouble or nullOptional
commoditystring or nullOptional
handling_unit_countinteger or nullOptional>=0
Number of freight handling units
handling_unit_typestring or nullOptional
Type of freight handling unit, e.g. pallet or case
po_numberslist of strings or nullOptional
reference_numberslist of objects or nullOptional
posted_rateinteger or nullOptional
max_buy_rateinteger or nullOptional
suggested_market_rateinteger or nullOptional
length_feetinteger or nullOptional
special_instructionslist of strings or nullOptional
notesstring or nullOptional
is_postedbooleanOptionalDefaults to false
last_posted_atdatetime or nullOptional

When Envoy’s posted flag last turned on (UTC). Stamped by the board sync or a manual post; null if the load has not been posted since tracking began.

last_unposted_atdatetime or nullOptional

When Envoy’s posted flag last turned off (UTC), by a board sweep or a manual un-post; null if never un-posted.

externally_posted_atdatetime or nullOptional

DAT posting creation time (UTC); null when unavailable or not supplied by DAT

temperature_setting_minimuminteger or nullOptional
temperature_setting_maximuminteger or nullOptional
temperature_run_typestring or nullOptional
last_reported_statestring or nullOptional
last_reported_citystring or nullOptional
last_reported_longdouble or nullOptional
last_reported_latdouble or nullOptional
tms_carrier_idstring or nullOptional
carrier_namestring or nullOptional
hauling_carrier_idstring or nullOptionalformat: "^car_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
hauling_carrier_namestring or nullOptional
hauling_carrier_mc_numberstring or nullOptional
hauling_carrier_dot_numberstring or nullOptional
carrier_completed_ratedouble or nullOptional
What the carrier that moved the load is paid, in USD, as reported by the TMS
customer_ratedouble or nullOptional
The customer's rate in USD, as reported by the TMS. Returned to API keys and org admins only
margindouble or nullOptional
Margin in USD, as reported by the TMS. Returned to API keys and org admins only
customer_namestring or nullOptional
tms_sales_rep_namesstring or nullOptional

Sales representative name(s) reported by the source TMS; not an Envoy user assignment

carrier_repobject or nullOptional
Contact information for various parties involved in the load
driverobject or nullOptional
Contact information for various parties involved in the load
carrier_rep_user_idstring or nullOptionalformat: "^usr_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
carrier_rep_user_namestring or nullOptional
carrier_rep_user_emailstring or nullOptional
assigned_to_ai_agentbooleanOptionalDefaults to false
stopslist of objectsOptional
contextmap from strings to anyOptional
custom_fieldsmap from strings to anyOptional
offer_countintegerOptionalDefaults to 0
Number of unique carrier offers received
max_offer_amountdouble or nullOptional
Highest offer amount received
min_offer_amountdouble or nullOptional
Lowest offer amount received
active_escalation_countintegerOptionalDefaults to 0
Number of ACTIVE escalations anchored to this load

Errors

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