API Reference · v1

Flawls Workshop OS API

REST + JSON. Authenticate with a workspace API key, exchange for a short-lived bearer token, then call any endpoint below. Idempotent writes via Idempotency-Key header.

Base URL
https://api.flawls.au
Latency
p50 64ms · p99 280ms
Uptime
99.98% trailing 90d
GET/v1/vehicles

List vehicles, filterable by customer or rego

Request example
curl -X GET https://api.flawls.au/v1/vehicles \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)"
Response 200
{ "data": [{ "id": "veh_0001", "rego": "FLW910", "year": 2023, "make": "Toyota", "model": "Supra GR" }] }
Auth

Bearer token in Authorization header. Scopes are derived from the API key's role.

Rate limits

600 requests / minute per workspace. Burst to 60 rps. X-RateLimit-Remaining on every response.