API documentation | API docs for agents | OpenAPI 3.1
GET /api/v1/reports/loads
ark.get_load_report
Returns permissioned paginated load report rows with lane, status, equipment, customer, carrier, revenue, expense, and margin fields.
- Availability
- Expanded preview
- Scopes
reports:read- ARK permissions
canViewReportscanViewLoadReport- Team visibility
- Required and enforced
- Idempotency-Key
- Not required
- Approval
- No MCP approval on REST API-token calls
- Rate limit
- API credential and organization budgets
Parameters
fromquerystringrequiredtoquerystringrequiredteam_idsquerystring- Comma-separated visible team IDs. Omit to use every team available to the credential.
load_statusquerystring- Comma-separated load statuses. Defaults to Pending, Dispatched, and Delivered.
customer_idquerystringsales_rep_idquerystringbroker_idquerystringcarrier_idquerystringorigin_cityquerystringorigin_statequerystringdestination_cityquerystringdestination_statequerystringload_sizequerystringtrailerquerystringdate_filter_typequerystring- one of: delivery_date, created_date, booking_date, pickup_date; default: "delivery_date"
customer_currencyquerystring- one of: USD, CAD, MXN
carrier_currencyquerystring- one of: USD, CAD, MXN
pagequeryinteger- min: 1
page_sizequeryinteger- min: 1; max: 500
sort_columnquerystring- one of: loadNumber, status, customerCurrency, carrierCurrency, revenue, expenses, margin, customer, carrier, origin, destination; default: "loadNumber"
sort_directionquerystring- one of: asc, desc; default: "desc"
Request body
None.
Example request
Shell
curl 'https://arktms.com/api/v1/reports/loads?from=<from>&to=<to>' \
-H "Authorization: Bearer $ARK_API_TOKEN"Success response
Report result
objectstringrequiredokbooleanrequiredapi_versionstringrequiredrequest_idstringrequireddataobjectrequireddata.filtersobjectrequireddata.loadsarray<object>requireddata.paginationobjectrequiredErrors
HTTP 400- Invalid request
HTTP 401- Authentication required
HTTP 403- Permission, scope, team, or entitlement denied