REST API reference

The default API prefix is https://your-domain.example/api/v1.

Authenticated operations use an access token:

Authorization: Bearer <accessToken>

Login with POST /api/v1/auth/login and refresh with POST /api/v1/auth/refresh.

Example login body:

{"identifier":"admin@example.com","password":"your-password","deviceName":"Android","platform":"android","appVersion":"1.0.0"}

API areas include health checks, login and passkeys, device pairing, user profiles, vehicles and sharing, trips and GPS tracking, odometer readings, dashboard statistics, mapping services, imports and exports, and administration.

The authoritative contract is api/openapi.yml. It provides exact endpoints, request bodies, response schemas, and authorization requirements.

When SHOW_API_UI=true, the running application also provides /api, /api/docs, and /api/v1/openapi.yml.