FleetFlow Customer API

Select your API key

FleetFlow supports multiple organizations. To get started, select the organization you want to interact with by providing the API key for that organization.

HEADERX-Api-Key: YOUR_API_KEY
Include your API key in all requests via the X-Api-Key header

Authenticate with the API

FleetFlow uses a token-based authentication system. Initial authentication requires either basic auth credentials or OTP verification. All subsequent requests must include the bearer token in the Authorization header.

GET/v1/auth

Details

Exchange credentials for authentication tokens
Requires Authentication
POST/v1/auth/refresh

Details

Get new access token using refresh token

Magic (OTP)

GET/v1/magic/email

Details

Request email OTP code
POST/v1/magic/email

Details

Verify email OTP code

Account Management

Manage customer accounts and preferences

GET/v1/account

Details

Get account details
Requires Authentication
POST/v1/account

Details

Create new account

Vehicle Management

Manage fleet vehicles and their data

GET/v1/vehicles

Details

List all vehicles
Requires Authentication
POST/v1/vehicles

Details

Register new vehicle
Requires Authentication

Components

GET/v1/vehicles/:uuid1/components

Details

List vehicle components
Requires Authentication
PATCH/v1/vehicles/:uuid1/components/:uuid2

Details

Update component details
Requires Authentication

Tracking

GET/v1/vehicles/:uuid1/track

Details

Get vehicle tracking data
Requires Authentication
POST/v1/vehicles/:uuid1/track

Details

Add tracking data point
Requires Authentication

Service Tickets

Manage vehicle service tickets and repairs

GET/v1/service_tickets

Details

List all service tickets
Requires Authentication
GET/v1/service_tickets/:uuid1

Details

Get service ticket details
Requires Authentication

Communication Threads

Real-time communication channels

WS/v1/threads

Details

WebSocket connection for real-time updates
Requires Authentication
GET/v1/threads

Details

List all threads
Requires Authentication