API reference
Interactive reference for GET /api/v1/loads — try real requests with your key.
Explore the endpoint below, or point your tooling at the raw
OpenAPI 3.1 document.
The Try it panel fires real requests — paste your fr8_live_… key
as the Bearer token. Requests count against your rate limit.
Authorization
bearerAuth Per-customer API key (fr8_live_…), sent as Authorization: Bearer <key>. Issued by FR8 Factory ops; rotate by requesting a second key, cutting over, then revoking the old one.
In: header
Query Parameters
1-based page number.
1 <= value1Rows per page. Values above 100 clamp to 100.
1 <= value <= 100100ISO 8601 date or datetime; only loads with updatedAt >= this value return.
date-timeFilter by load status (repeatable — pass it multiple times for an OR set). Values from the closed status list.
ISO 8601 date/datetime; only loads with pickDate >= this (narrows within the 12-month window, never widens it).
date-timeISO 8601 date/datetime; only loads with pickDate <= this.
date-timeISO 8601 date/datetime; only loads with delDate >= this.
date-timeISO 8601 date/datetime; only loads with delDate <= this.
date-timeExact match on your PO number.
Exact match on your billing reference.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/v1/loads"{ "data": [ { "loadNumber": "string", "poNumber": "string", "billingRefNumber": "string", "originCity": "string", "originState": "string", "originZip": "string", "originWarehouse": "string", "destinationCity": "string", "destinationState": "string", "destinationZip": "string", "destinationWarehouse": "string", "status": "PrePlanning", "scheduledPickupDate": "2019-08-24T14:15:22Z", "scheduledPickupTime": "string", "scheduledDeliveryDate": "2019-08-24T14:15:22Z", "scheduledDeliveryTime": "string", "tenderedDate": "2019-08-24T14:15:22Z", "actualPickupDate": "2019-08-24T14:15:22Z", "actualDeliveryDate": "2019-08-24T14:15:22Z", "requestedDeliveryDate": "2019-08-24T14:15:22Z", "miles": "string", "totalCost": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "page": -9007199254740991, "pageSize": -9007199254740991, "totalCount": -9007199254740991, "hasMore": true}{ "error": "string", "details": [ "string" ]}{ "error": "string", "details": [ "string" ]}{ "error": "string", "details": [ "string" ]}{ "error": "string", "details": [ "string" ]}