List Loads

GET /v2/tms-api/loads

Retrieve a paginated list of loads in your organization with filtering and sorting options.

Query Parameters

pageintegerdefault: 1

Page number (1-indexed)

page_sizeintegerdefault: 50

Number of items per page (max 100)

statusstring

Filter by status. Valid values: `ACTIVE`, `TENDERED`, `COVERED`, `DELIVERED`, etc.

equipment_typestring

Filter by equipment type. Valid values: `DRY_VAN`, `REEFER`, `FLATBED`, etc.

customer_external_reference_idstring

Filter by customer external reference ID

carrier_external_reference_idstring

Filter by carrier external reference ID

pickup_date_fromstring

Filter by pickup date range start (ISO 8601)

pickup_date_tostring

Filter by pickup date range end (ISO 8601)

sortstring

Sort field and direction. Format: `field` or `-field` (descending)

Request Examples

cURL

# List all active loads
curl -X GET "https://api.mentium.io/v2/tms-api/loads?status=ACTIVE&page=1" \
  -H "X-API-Key: your_api_key_here"

# Filter by customer
curl -X GET "https://api.mentium.io/v2/tms-api/loads?customer_external_reference_id=CUST-ACME-001" \
  -H "X-API-Key: your_api_key_here"

Python

import requests

response = requests.get(
    "https://api.mentium.io/v2/tms-api/loads",
    headers={"X-API-Key": "your_api_key_here"},
    params={"status": "ACTIVE", "page": 1, "page_size": 50}
)
print(response.json())

Response

200 OK

{
  "items": [
    {
      "id": "load_abc123",
      "external_reference_id": "LOAD-001",
      "status": "ACTIVE",
      "equipment_type": "DRY_VAN",
      "description": "Electronics shipment",
      "customer_external_reference_id": "CUST-ACME-001",
      "customer_name": "Acme Corporation",
      "total_distance": 285,
      "max_buy_rate": 2200,
      "stops": [...],
      "created_at": "2026-01-29T10:30:00Z",
      "updated_at": "2026-01-29T14:20:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total": 1,
    "total_pages": 1,
    "has_more": false
  }
}