TMS API
TMS API - Loads

List Loads

List all loads with optional filtering and pagination.

get/v2/tms-api/loads

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    none declared

Query parameters

tms_statusstring nullable

Filter by raw TMS status (e.g., 'Dispatched', 'At Shipper')

mentium_statusstring nullable

Filter by Mentium normalized status (PLANNED, ACTIVE, COVERED, IN_TRANSIT, DELIVERED, COMPLETED, TERMINATED)

equipment_typestring nullable

Filter by equipment

customer_external_reference_idstring nullable

Filter by customer

carrier_external_reference_idstring nullable

Filter by carrier

pickup_date_fromstring date-time nullable

Pickup date from

pickup_date_tostring date-time nullable

Pickup date to

delivery_date_fromstring date-time nullable

Delivery date from

delivery_date_tostring date-time nullable

Delivery date to

is_hotboolean nullable

Filter by hot/priority

limitinteger

Number of items

offsetinteger

Offset for pagination

sort_bystring nullable

Sort field

sort_order'asc' | 'desc'

Sort order options.

Sort order

Headers

X-API-Keystring nullable

API key for authentication

Response

Successful Response

total_countinteger required

Total number of items matching the query

has_moreboolean required

Whether there are more items available

limitinteger required

Number of items requested

offsetinteger required

Number of items skipped

Changes

No recorded changes to this operation across all 2 revisions of this API.