Docs
API Reference

API Reference

HTTP API reference for autoGMS tenant routes.

API Reference

autoGMS exposes a REST API for programmatic access to your Garage data. All endpoints are scoped to a specific Team and Garage via URL parameters.

Base URL

https://your-domain.com/api

Authentication

All API requests require an active session cookie. Authenticate by signing in through the web application. API-key-based authentication is planned for a future release.

Common Headers

Content-Type: application/json
Cookie: <session-cookie>

Workspace and Garage Scoping

Most endpoints require workspaceSlug and projectSlug query parameters (or path segments) to identify the Team and Garage.

Endpoints

Bookings

MethodPathDescription
GET/api/bookingsList bookings
GET/api/bookings/:idGet booking by ID
POST/api/bookingsCreate a booking
PATCH/api/bookings/:idUpdate a booking
POST/api/bookings/:id/transitionTransition booking status

Customers

MethodPathDescription
GET/api/customersList customers
GET/api/customers/:idGet customer by ID
POST/api/customersCreate a customer
PATCH/api/customers/:idUpdate a customer

Vehicles

MethodPathDescription
GET/api/vehiclesList vehicles
POST/api/vehiclesCreate a vehicle

Invoices

MethodPathDescription
GET/api/invoicesList invoices
GET/api/invoices/:idGet invoice by ID
POST/api/invoicesCreate an invoice
POST/api/invoices/:id/paymentsRecord a payment
GET/api/invoices/:id/pdfDownload invoice PDF

Expenses

MethodPathDescription
GET/api/expensesList expenses
POST/api/expensesCreate an expense

Services

MethodPathDescription
GET/api/servicesList services
POST/api/servicesCreate a service

Bays

MethodPathDescription
GET/api/baysList bays
POST/api/baysCreate a bay

Reports

MethodPathDescription
GET/api/reports/profit-lossProfit & Loss report
GET/api/reports/balance-sheetBalance Sheet
GET/api/reports/cash-flowCash Flow report

Estimates

MethodPathDescription
GET/api/estimatesList estimates
POST/api/estimatesCreate an estimate

Error Responses

All errors follow a standard format:

{
  "error": "Description of the error",
  "code": "ERROR_CODE"
}

Common error codes:

  • UNAUTHORIZED — Session invalid or expired.
  • FORBIDDEN — Insufficient permissions for this action.
  • NOT_FOUND — Resource does not exist.
  • FEATURE_GATED — Feature not available on your plan.
  • VALIDATION_ERROR — Request body failed validation.

Rate Limiting

API requests are not currently rate-limited. Fair use is expected. Rate limiting may be introduced in a future release.

On this page