Skip to content
TMSWORX

Integrations · API

The same API the application uses.

Every TMSWORX screen is built on a JSON API. Your systems call it with company API tokens, and the same permissions, validation and company isolation apply to every call, so integrations follow the same rules as your users.

Coverage

What the API covers

  • Orders and stops
  • Webhook subscriptions for order, trip, stop and document events
  • Trips, assignments and stop events
  • Dispatch board
  • Billing queue and invoices
  • Driver settlements
  • Work orders and maintenance
  • Parts inventory
  • Safety: inspections, defects, incidents
  • Documents and PDFs
  • Reports with CSV output
  • Master data (customers, locations, drivers, equipment, commodities and more)
  • Terminal inventory

Example request (illustrative)

GET /api/orders?status=Available&page=1
Authorization: Bearer <your API token>

200 OK
{
  "items": [
    { "number": "ORD000080", "status": "Available",
      "customer": "Pinewood Paper Mills",
      "origin": "New Orleans, LA", "destination": "Port Arthur, TX" }
  ],
  "total": 26, "page": 1, "pageSize": 25
}

Permission-checked

Each endpoint requires a specific permission, the same as the screens.

Validated

Requests are validated with field-level error messages, and conflicting edits are rejected rather than overwritten.

Company-isolated

Data is always scoped to the token's or user's company.

API tokens

Administrators create tokens in Settings. Each token has a role, can be read-only, has its own rate limit and can be revoked at any time.

OpenAPI document

A published OpenAPI document describes the endpoints available to tokens, so client code can be generated.

Signed webhooks

Subscribe to order, trip, stop and document events. Deliveries are HMAC-signed and retried with backoff, with a delivery history.

Data feeds: read-only JSON or CSV feeds for Power BI, Excel and other BI tools use the same tokens. See the BI data feeds and webhooks details.

Ready to modernize your transportation operation?

See TMSWORX with your own lanes, equipment and workflows in mind. We will walk through dispatch, billing and the modules that matter to your fleet.

TMSWORX REST API, OpenAPI and Webhooks | TMSWORX