Overview

Open VTS REST API overview, role hierarchy, base headers, and API structure.

API at a Glance

Version: 1.0.0
Base URL: https://<your-domain>:3001
Last Updated: 2026-03-08
Audience: Mobile App Developers
Total Endpoints: 426
Data Models: 10
Enumerations: 20
WebSocket Namespaces: 2

API Style

HTTP Verbs·GET, POST, PATCH, PUT, DELETE

Encoding·JSON responses

Auth·JWT Bearer tokens

File Uploads·multipart/form-data

Streaming·Server-Sent Events (SSE)

Real-time·Socket.IO

Role Hierarchy

Open VTS uses a multi-tenant role hierarchy. Each role inherits access from its children.

Role Tree

SUPERADMIN (platform owner)
  └── ADMIN (fleet operator / customer)
        ├── USER (fleet manager)
        │     └── SUBUSER (restricted user)
        ├── TEAM (team member)
        └── DRIVER (vehicle driver)

Base Headers

All requests should include the following headers:

Header	Value	Required
`Content-Type`	application/json	Yes (except file uploads)
`Authorization`	Bearer <jwt_token>	Yes (protected endpoints)

Endpoint Groups

Group	Base Path	Auth	Endpoints
Auth APIs	`/auth`	Public	13
Superadmin APIs	`/superadmin`	SUPERADMIN	141
Admin APIs	`/admin`	ADMIN	152
User APIs	`/user`	ADMIN \| USER	115
Health APIs	`/health`	Public	5

Authentication