Which endpoint do I need?

Use this page to find the right V2 endpoint for what you’re trying to do. Each section maps a common task to the endpoint that handles it.

All V2 endpoints use RESTful HTTP methods (GET, POST, PUT, DELETE). Parameters go in the path or query string; the token endpoint takes a form body, and POST /v2/api/vehicles/list and the webhook POST/PUT routes take JSON — see Content types. V2 endpoints are at /v2/api/.... If you need the older V1 endpoints, switch to the V1 (Legacy) version in the version selector.

Tracking & location

I want to…	Endpoint
See where my vehicles are right now	`GET /v2/api/companies/{id}/vehicles/last-position` — once per company: your own (`level` 0) and each direct sub-company (`level` 1), then de-duplicate by `deviceId` (or `imei` when it is `-1`)
See where one vehicle is right now	`GET /v2/api/vehicles/{id}/last-position`
Find vehicles near a point on the map	`GET /v2/api/companies/{id}/vehicles/nearest`
See the route a vehicle drove (trip replay)	`GET /v2/api/replay/{id}`
Get raw GPS point history for a vehicle	`GET /v2/api/vehicles/{id}/positions`
Check when a vehicle was last online (its latest heartbeat)	`GET /v2/api/vehicles/{id}/last-online` or `GET /v2/api/companies/{id}/vehicles/last-time-online`

Fleet & vehicle management

I want to…	Endpoint
Get my company ID (needed for most calls)	`GET /v2/api/companies`
Get the latest data for up to 50 known vehicles	`POST /v2/api/vehicles/list`
Look up vehicle metadata by IMEI, ID, or VIN	`GET /v2/api/vehicles/info`
Convert an IMEI to a public vehicle ID	`GET /v2/api/vehicles/{imei}/device-ids`
Rename a vehicle	`PUT /v2/api/vehicles/{id}/name`
Update a vehicle’s odometer reading	`PUT /v2/api/vehicles/{id}/odometer`

Alerts

I want to…	Endpoint
Retrieve recent alert records (speeding, geofence, etc.)	`GET /v2/api/companies/{id}/alert-records`
List alert configurations (definitions, not events)	`GET /v2/api/companies/{id}/alerts`
Mark one alert record as read or unread	`PUT /v2/api/alerts/{id}/{date}/update-read-status`
Mark all alert records (the 10 types in Alert records) as read, across every company your token can read	`PUT /v2/api/companies/{id}/set-all-alerts-read`

Vehicle health & diagnostics

I want to…	Endpoint
Get battery health scores and voltages for the vehicles mapped to your token’s own company	`GET /v2/api/battery-health`
Get OBD-II / CAN fault codes from a vehicle	`GET /v2/api/vehicles/{id}/engine-codes`

Webhooks

I want to…	Endpoint
Subscribe to real-time alert events	`POST /v2/api/webhooks`
List my webhook subscriptions	`GET /v2/api/webhooks`
Update or delete a webhook	`PUT /v2/api/webhooks/{id}` · `DELETE /v2/api/webhooks/{id}`
Link an alert configuration to a webhook	`POST /v2/api/webhooks/{id}/link-alert`

Authentication

I want to…	Endpoint
Authenticate with an API key	`POST /v2/api/authentication/token/api-key`

Most endpoints require a company ID. If you don’t have it, call GET /v2/api/companies first — your own company is the item with level 0, listed last.

Getting Started

Guides

Authentication

Companies & fleet

Vehicles

Vehicle commands

Alerts

Telemetry & replay

Insights & diagnostics

Webhooks

Reference

Which endpoint do I need?

Tracking & location

Fleet & vehicle management

Alerts

Vehicle health & diagnostics

Webhooks

Authentication

​Tracking & location

​Fleet & vehicle management

​Alerts

​Vehicle health & diagnostics

​Webhooks

​Authentication

Tracking & location

Fleet & vehicle management

Alerts

Vehicle health & diagnostics

Webhooks

Authentication