Skip to Content
FR8 Factory Docs

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.

GET
/api/v1/loads

Authorization

bearerAuth
AuthorizationBearer <token>

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

page?integer

1-based page number.

Range1 <= value
Default1
pageSize?integer

Rows per page. Values above 100 clamp to 100.

Range1 <= value <= 100
Default100
updatedSince?string

ISO 8601 date or datetime; only loads with updatedAt >= this value return.

Formatdate-time
status?array<>

Filter by load status (repeatable — pass it multiple times for an OR set). Values from the closed status list.

pickupFrom?string

ISO 8601 date/datetime; only loads with pickDate >= this (narrows within the 12-month window, never widens it).

Formatdate-time
pickupTo?string

ISO 8601 date/datetime; only loads with pickDate <= this.

Formatdate-time
deliveryFrom?string

ISO 8601 date/datetime; only loads with delDate >= this.

Formatdate-time
deliveryTo?string

ISO 8601 date/datetime; only loads with delDate <= this.

Formatdate-time
poNumber?string

Exact match on your PO number.

billingRefNumber?string

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}

Quickstart

From API key to your first page of loads in three steps.

Authentication

Bearer API keys — scoping, failure modes, and zero-downtime rotation.

Help

How do I get API access?

API keys are issued per customer by the FR8 Factory team. Ask your account contact — or send us a request through the Help desk tab with your company name and use case.

How do I authenticate requests?

Send your API key in the Authorization header on every request. Keys are secret — never ship them in browser code or mobile apps.

Open the guide — How do I authenticate requests?

How do I keep my copy of the data in sync?

Use delta polling: request only records changed since your last sync cursor instead of re-downloading everything. The guide covers cursors, ordering, and replay safety.

Open the guide — How do I keep my copy of the data in sync?

What are the rate limits?

Limits are per API key and documented on the rate-limits page, along with the response headers that tell you where you stand and how to back off.

Open the guide — What are the rate limits?

What does each load field mean?

The load field dictionary defines every field the API returns — types, nullability, and freight-domain meaning (pick vs drop dates, AR, equipment types).

Open the guide — What does each load field mean?

Found a bug or missing data?

Send it through the Help desk tab with the request you made and what you expected back. You'll get a reference code, and we'll email you when it's resolved.