Developer API

Access your fleet data programmatically. Integrate BridgeWorks One™ with your existing systems using our REST API.

Getting Started

All API requests require authentication using a Bearer token. Generate an API key from your API Settings page and include it in every request header.

Authentication Header

HTTP Header

Authorization: Bearer bw1_live_<your-api-key>

Example Request

cURL

curl -X GET "https://BridgeWorksOne.com/api/v1/health" \
  -H "Authorization: Bearer bw1_live_abc123def456..."

Base URL

All API endpoints are relative to the following base URL:

Base URL

https://BridgeWorksOne.com/api/v1

All responses are JSON. All request bodies should use Content-Type: application/json.

Rate Limits

API rate limits are enforced per API key, per day (resets at 00:00 UTC).

Plan	Daily Requests	Rate Limit Header
Starter	100 / day	`X-RateLimit-Limit: 100`
Pro	1,000 / day	`X-RateLimit-Limit: 1000`
Scale	10,000 / day	`X-RateLimit-Limit: 10000`

Endpoints

GET/api/v1/compliancecompliance:read

List compliance items for your workspace (first 50).

Response

{
  "data": [
    {
      "id": "item_abc123",
      "title": "CDL License Renewal",
      "category": "driver",
      "status": "at_risk",
      "riskLevel": "high",
      "dueDate": 1748736000000
    }
  ],
  "count": 1
}

GET/api/v1/driversdrivers:read

List all active drivers in your workspace.

Response

{
  "data": [
    {
      "id": "drv_xyz789",
      "firstName": "James",
      "lastName": "Carter",
      "cdlNumber": "DL-4821",
      "cdlClass": "A",
      "status": "active"
    }
  ],
  "count": 1
}

GET/api/v1/documentsdocuments:read

List documents stored in your workspace vault.

Response

{
  "data": [
    {
      "id": "doc_def456",
      "name": "Annual Inspection - Truck 42",
      "category": "Vehicle Maintenance",
      "status": "active",
      "expirationDate": 1751328000000
    }
  ],
  "count": 1
}

GET/api/v1/dispatch/loadsdispatch:read

List dispatch loads and their current status.

Response

{
  "data": [
    {
      "id": "load_ghi789",
      "loadNumber": "BW-2024-0042",
      "customerName": "Prime Freight Co.",
      "origin": "Chicago, IL",
      "destination": "Memphis, TN",
      "status": "in_transit"
    }
  ],
  "count": 1
}

GET/api/v1/reports/summaryreports:read

Get a fleet summary report with key metrics.

Response

{
  "data": {
    "activeDrivers": 8,
    "activeVehicles": 6,
    "complianceScore": 87,
    "openTasks": 12,
    "activeLoads": 4,
    "generatedAt": 1748736000000
  }
}

GET/api/v1/healthNo auth required

API health check. No authentication required.

Response

{
  "status": "ok",
  "timestamp": 1748736000000,
  "version": "1.0.0"
}

Error Codes

The API uses standard HTTP status codes. Error responses include a JSON body with an error field.

Error Response Format

{
  "error": "Unauthorized",
  "message": "Invalid or missing Bearer token.",
  "status": 401
}

Status	Name	Description
401	Unauthorized	Missing or invalid Bearer token.
403	Forbidden	API key doesn't have the required scope for this endpoint.
429	Rate Limited	Daily request limit exceeded. Resets at 00:00 UTC.
500	Internal Error	Unexpected server error. Contact support if this persists.

Webhooks

Coming Soon

Receive real-time event notifications via HTTP POST to your endpoints. Subscribe to compliance alerts, driver updates, dispatch events, and more.

Webhook support is on our roadmap. Vote for this feature →

SDKs

Coming Soon

Official client libraries for popular programming languages.

JavaScript / TypeScript

Python