Skip to Content
FR8 Factory Docs

Quickstart

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

The Customer Data API gives your systems read-only access to your own load data — one endpoint, delta polling, page-number pagination.

1. Get an API key

Keys are issued by FR8 Factory operations — ask your account contact. You'll receive a key that looks like this:

fr8_live_3fK9…

The key is shown to us exactly once at creation, so store it in your secret manager when you receive it. A key is scoped to your company: it can only ever return your own loads. Each key has a per-minute rate limit (default 10 — see Rate limits).

2. Make your first call

curl -H "Authorization: Bearer fr8_live_your_key_here" \
  "https://www.fr8factory.com/api/v1/loads?pageSize=5"

3. Read the response

{
  "data": [
    {
      "loadNumber": "123456",
      "poNumber": "PO-8801",
      "billingRefNumber": "CLS-2214",
      "originCity": "Boca Raton",
      "originState": "FL",
      "originZip": "33431",
      "originWarehouse": "DC East",
      "destinationCity": "Dallas",
      "destinationState": "TX",
      "destinationZip": "75201",
      "destinationWarehouse": null,
      "status": "InTransit",
      "scheduledPickupDate": "2026-07-01T00:00:00.000Z",
      "scheduledPickupTime": "08:00",
      "scheduledDeliveryDate": "2026-07-03T00:00:00.000Z",
      "scheduledDeliveryTime": "14:30",
      "tenderedDate": "2026-06-28T15:00:00.000Z",
      "actualPickupDate": "2026-07-01T08:12:00.000Z",
      "actualDeliveryDate": null,
      "requestedDeliveryDate": "2026-07-03T00:00:00.000Z",
      "miles": "1112.4",
      "totalCost": "2350.5",
      "createdAt": "2026-06-28T14:55:00.000Z",
      "updatedAt": "2026-07-02T10:00:00.000Z"
    }
  ],
  "page": 1,
  "pageSize": 5,
  "totalCount": 1240,
  "hasMore": true
}

Every field is documented in the field dictionary. For syncing loads into your own system on a schedule, read delta polling and pagination — it covers the one caveat that matters.

Machine-readable contract

  • OpenAPI 3.1: /api/v1/openapi.json — point a client generator at it.
  • Postman collection: Customer Data API on Postman — import it, select the bundled environment, paste your API key, and run the three flows (first page, delta pull, pagination walk).

Getting help

Email your FR8 Factory account contact. Include the loadNumber and the full request URL (never the key) when reporting a data question.

On this page

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.