Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ShohjahonSohibov/repo-for-agent/llms.txt

Use this file to discover all available pages before exploring further.

The Brokers API covers everything related to the companies and individuals that dispatch freight to your fleet. Broker records store regulatory identifiers (MC and DOT numbers) alongside contact details, and are automatically created or updated when QuickManage syncs load data. The related Addresses API enriches location data with geocoded latitude/longitude coordinates. Country and state reference endpoints are public and require no authentication.

​
BrokersController — /api/brokers

Manage customer and broker profiles. All endpoints require JWT authentication.

​
GET /api/brokers

List all brokers for the current company, with optional text search and pagination. Required permission: Brokers.View
cURL
curl https://your-domain.com/api/brokers \
  -H "Authorization: Bearer <accessToken>"

​
GET /api/brokers/{id}

Retrieve a single broker by its ID. Required permission: Brokers.View
​
id
number
required
The broker’s database ID.
Response fields
​
id
number
required
Unique broker ID.
​
name
string
required
Legal business name of the broker or customer.
​
email
string
Primary contact email address.
​
phone
string
Primary contact phone number.
​
mcNumber
string
Motor Carrier (MC) number issued by the FMCSA.
​
dotNumber
string
Department of Transportation (DOT) number.
cURL
curl https://your-domain.com/api/brokers/42 \
  -H "Authorization: Bearer <accessToken>"

​
POST /api/brokers

Create a new broker record. Required permission: Brokers.Create
​
name
string
required
Legal business name of the broker.
​
email
string
Primary contact email address.
​
phone
string
Primary contact phone number.
​
mcNumber
string
Motor Carrier number.
​
dotNumber
string
DOT number.
cURL
curl -X POST https://your-domain.com/api/brokers \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Atlas Freight Solutions",
    "email": "dispatch@atlasfreight.com",
    "phone": "555-0100",
    "mcNumber": "MC-987654",
    "dotNumber": "DOT-123456"
  }'

​
PUT /api/brokers/{id}

Update an existing broker’s details. Required permission: Brokers.Update
​
id
number
required
The broker’s database ID.

​
DELETE /api/brokers/{id}

Delete a broker record. This is a soft delete — the broker remains in the database with isDeleted: true. Required permission: Brokers.Delete
​
id
number
required
The broker’s database ID.

​
GET /api/brokers/{id}/loads

List all loads associated with a specific broker. Required permission: Loads.View
​
id
number
required
The broker’s database ID.
cURL
curl https://your-domain.com/api/brokers/42/loads \
  -H "Authorization: Bearer <accessToken>"
Brokers are automatically created or updated when QuickManage syncs load data via the background import job. Manual creation is also supported for brokers not managed through QuickManage.

​
AddressesController — /api/addresses

Address management with automatic geocoding. When you create an address, the API resolves the street and city into latitude/longitude coordinates using the configured geocoding service.

​
GET /api/addresses

List addresses for the current company. Required permission: Addresses.View

​
POST /api/addresses

Create a new address. The API automatically geocodes the address to populate latitude and longitude. Required permission: Addresses.Create
​
line1
string
required
Street address line 1.
​
city
string
required
City name.
​
state
string
required
State or province abbreviation (e.g., TX, CA).
​
zip
string
Postal or ZIP code.
​
country
string
Two-letter ISO country code (e.g., US).
Response fields
​
id
number
required
Address ID.
​
line1
string
required
Street address line 1.
​
city
string
required
City name.
​
state
string
required
State abbreviation.
​
zip
string
Postal code.
​
country
string
Country code.
​
latitude
number
Geocoded latitude coordinate.
​
longitude
number
Geocoded longitude coordinate.
cURL
curl -X POST https://your-domain.com/api/addresses \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{
    "line1": "1600 Amphitheatre Pkwy",
    "city": "Mountain View",
    "state": "CA",
    "zip": "94043",
    "country": "US"
  }'

​
POST /api/addresses/geocode

Resolve a free-form address string to latitude/longitude without saving a record. Useful for ETA calculations or map previews before committing a new address. Required permission: Addresses.Create
​
address
string
required
Full address string to geocode (e.g., "1600 Amphitheatre Pkwy, Mountain View, CA 94043").
Response fields
​
latitude
number
required
Resolved latitude coordinate.
​
longitude
number
required
Resolved longitude coordinate.
cURL
curl -X POST https://your-domain.com/api/addresses/geocode \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{"address": "1600 Amphitheatre Pkwy, Mountain View, CA 94043"}'
Response
{
  "latitude": 37.422408,
  "longitude": -122.084068
}

​
CountryController — /api/countries

Reference list of countries. No authentication required.
MethodEndpointDescription
GET/api/countriesList all countries
GET/api/countries/{id}Get a country by ID

​
StatesController — /api/states

Reference list of states and provinces. No authentication required.
MethodEndpointDescription
GET/api/statesList all states
GET/api/states/{countryId}/statesList states for a specific country
GET/api/states/{id}Get a state by ID

​
RateSavingsController — /api/rate-savings

Track and manage driver rate savings — the difference between the negotiated rate and the market rate for a given load.

​
GET /api/rate-savings

List all rate savings records for the current company. Required permission: RateSavings.View

​
GET /api/rate-savings/{driverId}

Get all rate savings records for a specific driver. Required permission: RateSavings.View
​
driverId
number
required
The driver’s database ID.

​
POST /api/rate-savings

Record a new rate savings transaction. Required permission: RateSavings.Create
cURL
curl -X POST https://your-domain.com/api/rate-savings \
  -H "Authorization: Bearer <accessToken>" \
  -H "Content-Type: application/json" \
  -d '{
    "driverId": 7,
    "loadId": 301,
    "savedAmount": 250.00
  }'

​
POST /api/rate-savings/{id}/adjust

Apply a manual adjustment to an existing rate savings record. Use this to correct data entry errors or apply negotiated credits after the fact. Required permission: RateSavings.Update
​
id
number
required
The rate savings record ID.
​
adjustmentAmount
number
required
Positive or negative dollar amount to add to the record.
​
reason
string
Human-readable reason for the adjustment, stored in the audit log.

Build docs developers (and LLMs) love

Get started for freeTalk to us