Skip to main content

API terminology and naming

This API uses a historical namespace that originates from Roo's first use case — fleet management.

In v1, most operational endpoints are grouped under the /fleets/... path. Functionally, these endpoints manage assets and their operational lifecycle, not vehicles only.

Key terminology mapping (v1)

Product conceptv1 API naming / locationNotes
Organization (company/tenant)Provisioned outside public APIAll API operations are executed within an existing organization context.
FleetfleetsHistorical term. Represents a collection of assets within an organization (an asset pool; effectively the fleet the organization manages).
AssetVehicle / carIn v1, assets are represented as vehicles under /fleets/....
Vehiclecars, car/{id}API naming for asset instances in v1.
Asset typeAsset Types APIDefines the category of an asset (car, truck, equipment).
Asset statusAsset Status APIDefines the current state of an asset.
InspectionInspections APIDefines inspection checklists and inspection runs for asset condition.
IssueIssues APIIssues can originate from inspections (or be created manually), but they are managed in the Issues API as a separate issue‑management category.
Work orderWork Orders APIWork orders are created to resolve issues or perform planned work.
Custom attributesCustom Attributes APIExtensible fields attached to most entities.
DocumentsDocuments APIFiles attached to organizations (company-level), assets, users, teams (groups), issues, or work orders.
MediaMedia Library APIPhotos and videos captured during inspections (used as evidence or context).
Alerts, reminders, tasksA.R.T. / Alerts APIAlert notifications, reminders, and task-based triggers.
WarehouseWarehouse APIInventory and spare parts management (optional). Work orders can reference parts from a warehouse when Warehouse API is enabled.
Purchase orderPurchase Orders APIOrder parts from vendors to complete work orders and repair or service assets (often to close inspections).
VendorVendors APIExternal suppliers and contractors (optional). Purchase orders are placed with vendors, and warehouses can be linked to vendors.
WarrantyWarranty APIWarranty coverage linked to assets (optional); warranty service is requested through claims in work orders.
ClaimClaims APIWarranty or compensation claims tied to work orders and asset service.
Reports & logsReports / Daily Logs APIInspection reports, daily logs, and analytical outputs, including insights (for example, Metabase reports).