API reference

Build with the NetModal API

Build powerful integrations with the NetModal REST API. Full access to loads, drivers, fleet, billing, and more.

Getting started

Base URL
https://api.netmodal.com/v1

All API requests require authentication via Bearer token. Include your API key in the Authorization header of every request.

Authentication Header
Authorization: Bearer YOUR_API_KEY

API keys can be generated from your dashboard under Settings > API Keys. Each key can be scoped to specific permissions and rate limits.

Endpoints

Authentication

POST /auth/login Authenticate and receive access token
POST /auth/register Create a new user account
POST /auth/refresh Refresh an expired access token

Loads

GET /loads List loads with filtering and pagination
POST /loads Create a new load
GET /loads/:id Get load details by ID
PUT /loads/:id Update load information
POST /loads/:id/assign Assign a driver to a load
POST /loads/:id/status Update load status

Drivers

GET /drivers List all drivers
POST /drivers Add a new driver
GET /drivers/:id Get driver profile and status
GET /drivers/:id/location Get driver's current GPS location

Fleet & Assets

GET /assets List trucks, trailers, and equipment
POST /assets Register a new asset
GET /assets/:id/maintenance Get asset maintenance history

Billing

GET /invoices List invoices with status filtering
POST /invoices Create a new invoice
POST /invoices/:id/send Send invoice to customer

Webhooks

GET /webhooks List configured webhooks
POST /webhooks Register a new webhook endpoint

Rate limits

Starter

100 requests/minute

Professional

1,000 requests/minute

Enterprise

10,000 requests/minute

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.