MEmentium
v2
tms
v2
tms
loads

List Loads

List loads with flexible dynamic filtering, pagination and sorting

Query Parameters: - integration_connection_id: TMS integration connection ID (required) - filters_json: JSON array of dynamic filters supporting ALL operators Example: [{"field": "mentium_status", "operator": "EQUALS", "value": "ACTIVE"}] Supported operators: - EQUALS - NOT_EQUALS - GREATER_THAN - LESS_THAN - GREATER_THAN_OR_EQUAL - LESS_THAN_OR_EQUAL - CONTAINS - NOT_CONTAINS - IN - NOT_IN - limit: Maximum results (default: 50) - offset: Pagination offset (default: 0) - sort_by: Sort field (default: "first_pickup_stop_appointment_start_at") Stop-bound canonical fields like "first_pickup_stop_appointment_start_at", "last_delivery_stop_appointment_start_at", "first_pickup_stop_target_arrival_earliest_at", etc. route through a stop-aware LATERAL sort in Vortex. - sort_order: Sort order "asc" or "desc" (default: "desc")

Returns: List of Load models with pagination metadata in headers

get/v2/tms/loads/

Request

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

Query parameters

integration_connection_idstring required
filters_jsonstring nullable

JSON array of dynamic filters: [{"field": "miles", "operator": "EQUALS", "value": 620}] - supports ALL operators (EQUALS, NOT_EQUALS, GREATER_THAN, LESS_THAN, CONTAINS, etc.)

limitinteger
offsetinteger
sort_bystring
sort_orderstring

Headers

mentium-workspace-idstring nullable

Response

Successful Response

idstring required

Load UUID

organization_idstring required

Organization UUID

integration_connection_idstring required

Integration connection UUID

external_reference_idstring required

External reference ID (e.g., L302537)

tms_display_reference_idstring nullable

Human-facing reference supplied by the TMS (e.g., Turvo customId)

display_reference_idstring nullable

Connection-preferred display identifier, falling back to external_reference_id

tms_statusstring nullable

Raw status from TMS system (e.g., 'Dispatched', 'At Shipper')

mentium_statusstring required

Mentium mapped status (PLANNED, ACTIVE, COVERED, IN_TRANSIT, DELIVERED, COMPLETED, TERMINATED, ARCHIVED, TEMP)

equipment_typestring nullable

Equipment type (e.g., REEFER, VAN, DRY INTERMODAL TEST)

descriptionstring nullable

Load description

mode_typestring nullable

Mode type (e.g., Brokerage, Asset)

transport_modestring nullable

Transport mode (TL, LTL)

service_typestring nullable

Service type

route_numstring nullable

Route number

is_trunkboolean

Is trunk load

is_round_tripboolean

Is round trip

is_primary_loadboolean

Is primary load

lengthnumber nullable

Length

widthnumber nullable

Width

heightnumber nullable

Height

piecesinteger nullable

Total pieces

pallet_countinteger nullable

Total pallet count

weightnumber nullable

Total weight

weight_uomstring nullable

Weight unit of measure (lbs, kg)

billable_weightnumber nullable

Billable weight

billable_weight_uomstring nullable

Billable weight unit

declared_valuenumber nullable

Declared value

ltl_reference_numberstring nullable

LTL reference number

carrier_pro_numberstring nullable

Carrier PRO number

beginning_buy_ratenumber nullable

Initial target offer to carriers

max_buy_ratenumber nullable

Maximum negotiation ceiling

buy_rates_set_atstring date-time nullable

When the buy rates were last set, by either an operator or the TMS

buy_rates_set_by_user_idstring nullable

Mentium user who set the buy rates; null means the TMS set them

is_hotboolean

Is hot/priority shipment

priority_levelstring nullable

Priority level

over_short_or_damagedboolean

Over/short/damaged flag

carrier_milesnumber nullable

Carrier miles

customer_milesnumber nullable

Customer miles

total_distancenumber nullable

Total distance

empty_distancenumber nullable

Empty/deadhead distance

trailer_lengthstring nullable

Trailer length

equipment_codestring nullable

Equipment code

chassis_numstring nullable

Chassis number

tractor_numstring nullable

Tractor number

trailer_numberstring nullable

Trailer number

seal_numberstring nullable

Seal number

driver_namestring nullable

Driver name

driver_phonestring nullable

Driver phone

first_pickup_stop_target_arrival_earliest_atstring date-time nullable

Canonical pickup window start (first PICKUP stop's target_arrival_earliest_at)

first_pickup_stop_target_arrival_latest_atstring date-time nullable

Canonical pickup window end (exclusive; first PICKUP stop's target_arrival_latest_at)

last_delivery_stop_target_arrival_earliest_atstring date-time nullable

Canonical delivery window start (last DELIVERY stop's target_arrival_earliest_at)

last_delivery_stop_target_arrival_latest_atstring date-time nullable

Canonical delivery window end (exclusive; last DELIVERY stop's target_arrival_latest_at)

elapsed_timeinteger nullable

Elapsed time in minutes

transit_timeinteger nullable

Transit time in minutes

created_datestring date-time nullable

Created date from TMS

activity_datestring date-time nullable

Activity date

rate_sourcestring nullable

Rate source (SpotQuote, Contract, Manual)

load_sourcestring nullable

Load source (Lmws, Manual)

is_trackingboolean

Is tracking enabled

tracking_link_urlstring nullable

Tracking link URL

integration_statusstring nullable

Integration status (Sent, New, Pending)

assigned_tostring nullable

Assigned dispatcher name

offer_statusesCarrierOfferStatus[]

Distinct carrier offer statuses for the load

late_tracking_statusstring nullable

Late-load tracking status when the load has an active late episode (LATE)

analytics_error_categorystring nullable

Category of the analytics error (INTERNAL_ERROR, EXTERNAL_DATA_VALIDATION, SKIPPED)

analytics_error_descriptionstring nullable

Description of the analytics error

batch_analyticsboolean

True if analytics processing is pending

lane_historical_load_countinteger nullable

All-time analyzed load count on this load's lane. None when no analytics history exists.

lane_historical_marginnumber nullable

All-time total margin (customer − carrier) on this load's lane. Drives the lane P/L tag (>0 profit, <0 loss, 0 break-even).

customer_historical_load_countinteger nullable

All-time analyzed load count for this load's customer. None when no analytics history exists.

customer_historical_marginnumber nullable

All-time total margin (customer − carrier) for this load's customer. Drives the customer P/L tag (>0 profit, <0 loss, 0 break-even).

archived_atstring date-time nullable

When the load was auto-archived

archive_reasonstring nullable

Human-readable reason the load was archived

external_linkstring nullable

External TMS link to view load

sales_rep_display_namestring nullable

Sales rep display name (from TMS user info or mapping)

sales_rep_mentium_user_idstring nullable

Mentium user ID when sales rep is mapped to a workspace user

assigned_dispatcher_rep_display_namestring nullable

Assigned dispatcher rep display name (from TMS user info or mapping)

assigned_dispatcher_rep_mentium_user_idstring nullable

Mentium user ID when assigned dispatcher rep is mapped to a workspace user

actual_dispatcher_display_namestring nullable

Actual dispatcher display name (from TMS user info or mapping)

actual_dispatcher_mentium_user_idstring nullable

Mentium user ID when actual dispatcher is mapped to a workspace user

created_atstring date-time required

Record created timestamp

updated_atstring date-time required

Record updated timestamp

Example response

[
  {
    "equipment_type": "REEFER",
    "external_reference_id": "L302537",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "integration_connection_id": "int-456",
    "mentium_status": "IN_TRANSIT",
    "organization_id": "org-123",
    "stops": [
      {
        "stop_number": 1,
        "stop_type": "PICKUP",
        "target_arrival_earliest_at": "2025-10-23T08:00:00Z",
        "target_arrival_latest_at": "2025-10-23T16:00:00Z"
      },
      {
        "stop_number": 2,
        "stop_type": "DELIVERY",
        "target_arrival_earliest_at": "2025-10-24T08:00:00Z",
        "target_arrival_latest_at": "2025-10-24T17:00:00Z"
      }
    ],
    "tms_status": "At Shipper",
    "weight": 45000,
    "weight_uom": "lbs"
  }
]

Changes

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