API Reference
REST API documentation for Rig Terminal. Available on the Dispatch plan.
Base URL
https://api.rigterminal.com
Authentication
All requests require a JWT bearer token. Obtain tokens via the login endpoint. Access tokens expire after 15 minutes; use the refresh token to obtain a new one.
Info
API keys for service-to-service integration are available in Settings → Security → API Keys.
Rate Limits
| Plan | Limit |
|---|---|
| Solo | 60 requests/minute |
| Fleet | 500 requests/minute |
| Dispatch | 200 requests/minute |
Endpoints
| Method | Endpoint | Description |
|---|---|---|
| POST | /auth/signup | Create a new account |
| POST | /auth/login | Authenticate and receive tokens |
| POST | /auth/refresh | Refresh an expired access token |
| GET | /fleet/trucks | List all trucks |
| POST | /fleet/trucks | Add a new truck |
| GET | /fleet/drivers | List all drivers |
| POST | /fleet/drivers | Add a new driver |
| GET | /loads/search | Search loads across all sources |
| POST | /loads/score | Get AI score for a load |
| POST | /loads/book | Book a load |
| GET | /compliance/hos/:driverId | Get HOS clocks for a driver |
| GET | /compliance/violations | List HOS violations |
| GET | /finance/banking/balance | Get checking account balance |
| POST | /finance/payroll/run | Run payroll for a pay period |
| GET | /finance/cards | List fleet cards |
| POST | /finance/invoices | Create an invoice |
| POST | /finance/factoring/submit | Submit a load for factoring |
| GET | /tax/estimate | Get tax estimate for current period |
| GET | /tax/ifta | Generate IFTA report |
Webhooks
Configure webhook endpoints to receive real-time notifications for events:
| Source | Events |
|---|---|
| Unit (Banking) | Account created, transfer completed, card transaction |
| Highnote (Cards) | Transaction authorized, transaction settled, card status change |
| Factoring | Invoice submitted, funds deposited, invoice disputed |
| QuickBooks/Xero | Sync completed, sync error |
| Twilio (Voice AI) | Call started, call completed, rate negotiated |
Error Format
All errors return a JSON object with status, error, and message fields. HTTP status codes follow standard conventions: 400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 429 (rate limited), 500 (server error).