Public API · Pro+
Connect your other tools to Workshop Hub
The Public API is included on the Pro+ plan. Create API keys in Settings and let other software read your customers, vehicles, jobs, invoices and bookings, and add new customers and bookings.
API keys
- The owner or an admin creates keys in Settings → API keys, and picks what each key can do (scopes).
- A key is shown once. Workshop Hub stores only a hash of it.
- See when each key was last used, and revoke a key at any time.
- Each key only sees your own workshop's data.
- Up to 120 requests a minute per key.
- Pro+ only, on a paid plan. Not included in free trials, Solo or Shop.
Endpoints
JSON over HTTPS at https://portal.workshophub.com.au. Send your key as Authorization: Bearer wh_live_….
- GET/api/v1/customersList or search customers (customers:read)
- GET/api/v1/customers/:idOne customer (customers:read)
- POST/api/v1/customersAdd a customer (customers:write)
- GET/api/v1/vehicles · /:idVehicles (vehicles:read)
- GET/api/v1/jobs · /:idJobs (jobs:read)
- GET/api/v1/invoices · /:idInvoices, read-only (invoices:read)
- GET/api/v1/bookings · /:idBookings (bookings:read)
- POST/api/v1/bookingsAdd a booking (bookings:write)
curl -H "Authorization: Bearer wh_live_YOUR_KEY" \ "https://portal.workshophub.com.au/api/v1/customers?limit=20"
Errors: 401 missing or wrong key, 403 plan or scope not allowed, 404 not found, 429 too many requests.