API Reference

This reference documents all available endpoints in the Mentium TMS API.

Base URL

https://api.mentium.io/v2/tms-api

Authentication

All requests require an API key in the X-API-Key header:

curl -X GET "https://api.mentium.io/v2/tms-api/locations" \
  -H "X-API-Key: your_api_key_here"

See Authentication for details on obtaining and managing API keys.

Available Resources

Locations

Manage pickup/delivery locations and facilities - List, create, update, delete locations - Batch operations supported

Loads

Manage shipments and freight - Full load lifecycle management - Status tracking and updates

Carriers

Manage carrier information - Carrier profiles and contacts - Credentials and certifications

Customers

Manage customer accounts - Customer profiles and contacts - Billing information

Common Patterns

Pagination

All list endpoints support pagination:

GET /locations?page=1&page_size=50

Filtering

Filter results using query parameters:

GET /loads?status=in_transit&customer_id=123

Sorting

Sort results using the sort parameter:

GET /locations?sort=-created_at  # Descending by created_at
GET /locations?sort=name         # Ascending by name

Response Codes

Code	Description
200	Success
201	Created
204	No Content (successful delete)
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
422	Validation Error
429	Rate Limited
500	Server Error