API Reference
API Reference
HTTP base URL, auth headers, response envelopes, and endpoint-family pages.
The default REST base URL is https://api.linxio.com/api. Authenticated
requests require an Authorization: Bearer <token> header from the login
endpoint.
The API reference is split by endpoint family. Publicly documented endpoints are included together with dashboard-derived endpoints represented in the SDK.
Endpoint families
Service Surface
AuthenticationPOST /loginPOST /login/otpPOST /token/refreshGET /mePOST /logoutVehicles and routesvehicle inventoryodometerengine-hourscountstypesroute historyDevices, sensors, and camerasdevice inventoryinstall/uninstallsensor reportscamera eventsAccounts, users, and driversclientsclient usersusersdriversreseller accountsGeofencesareas and area groupsFuelfuel transactionssummariescardsfuel typesReports and formsscheduled reports and digital form answersMetadatacountriesrolesplanssettingsthemeslanguagesRealtimecoordinates and notification Socket.IO namespacesRequest conventions
Parameters
AuthorizationBearer token
requiredSend the JWT token returned by /login or /token/refresh for every authenticated endpoint.
Content-Typeapplication/json
optionalSend for JSON request bodies.
fields[]string[]
optionalSeveral list endpoints accept repeated fields[] parameters to reduce response size.
limitnumber
optionalMaximum records per page for paginated endpoints.
pagenumber
optionalPage number for paginated endpoints.
Default:
1Response envelope
Most list endpoints return a pagination envelope:
{
"page": 1,
"limit": 100,
"total": 123,
"data": [],
"aggregations": null
}Most entity endpoints return the entity directly. Endpoints returning 204 No Content are represented by LinxioResult<void> in the SDK.