REST OpenAPI (Swagger)
LiveAuth, tenants, customers, vehicles, repair orders, estimates, invoices, inventory, bookings, and more — documented at /docs on the API host.
Open →Developers
Workshop Wrench API — open enough to integrate, honest enough to trust
Shop systems should not be black boxes. We ship REST OpenAPI with multi-tenant isolation so partners, multi-location groups, and technical owners can build without reverse-engineering a closed SaaS.
Surfaces
What you can build against today
Status labels match product truth — Live means usable in demo/API; Stub/Dry-run means do not treat as Connected.
Multi-tenant JWT
LiveEvery business row carries tenantId. Bearer tokens (and dual-mode cookie for the app) keep shop data isolated.
Open →Portal tokens
LiveCustomer estimate approve without a staff login — deep-link friendly for SMS/email.
Open →Webhooks
StubOutbound event hooks planned on Scale. Do not build production automations assuming live webhook delivery today.
Open →Accounting adapters
Dry-runXero dry-run / gated live path; MYOB after Xero. Books of record stay in the ledger — workshop OS owns jobs and operational invoices.
Open →Docker / local stack
LiveFirst-class local compose path for integrators who refuse black-box only SaaS.
Open →API domain map
Module groups behind /docs
Indicative Nest module map. Status is marketing-honest: shells and stubs are not Connected. Use Swagger for exact routes.
| Domain | Status | Includes |
|---|---|---|
| Core shop OS | Live | Auth · tenants · customers · vehicles · repair orders · estimate lines · labour · inspections · media · search · audit |
| Money path | Live | Invoices (GST) · payment records · documents · dashboard KPIs · reports pack |
| Parts & purchasing | Live | Parts catalogue · PO/receive · reserve · stock transfer · supplier search shell |
| CX & bookings | Live+ | Public booking · portal tokens · bookings ICS · comms dispatch · SMS mock|Twilio |
| Money adapters | Stub / Dry-run | Stripe shop Checkout stub|live by key · Xero dry-run · MYOB dry-run · SaaS billing portal stub |
| Scale shells | Partial / Shell | Fleet accounts · warranty claims · process rules simulate · AI note shell · EFTPOS simulate · AU parts connected:false · rego shell |
| Platform | Live / Stub | Plans · entitlements · onboarding · import · notifications · feedback · platform admin (separate app) |
| Parts marketplace | Sibling | Separate marketplace API/web (M0–M4) — not the shop OS OpenAPI surface. Do not conflate with AU supplier punch-out. |
Guided evaluation scripts: demo playbooks · Process sequences: /processes
Integration principles
- • Workshop OS owns jobs, estimates, and operational invoices — not your general ledger.
- • Prefer OpenAPI + adapters over logo walls. Status is Live / Stub / Dry-run / Planned.
- • Tenant isolation is mandatory: never call business APIs without a tenant-scoped token.
- • Public booking and portal tokens are designed for customer-facing embeds — rate limits apply.
Local default API docs: http://localhost:8088/docs
FAQ
Developer questions
Is there a public sandbox?
Yes — the multi-tenant demo shop and local Docker stack expose the same OpenAPI surface. Use published demo credentials for evaluation; production tenants use their own JWT.
Are webhooks live?
Outbound webhooks are on the Scale packaging path and labeled Stub/Partial until delivery is product-complete. Prefer polling OpenAPI or ask sales for Scale delivery depth.