Skip to main content
GET
/
api
/
v2
/
vehicles
/
{id}
/
odometer
Get odometer (V2)
curl --request GET \
  --url https://api.telemax.com.au/api/v2/vehicles/{id}/odometer \
  --header 'Authorization: Bearer <token>'
{
  "odometerSource": "GPS",
  "odometerValue": 154200.5
}

​
Overview

Returns the current odometer value and whether it is sourced from the vehicle’s CAN bus or GPS/GNSS.
Rate limit: 120 requests per 60 seconds per token.

​
Endpoint

GET /api/v2/vehicles/{id}/odometer

​
Path parameters

​
id
integer
required
Legacy vehicle ID.

​
Response

200 OK — returns the odometer source and current reading.
FieldTypeDescription
odometerSourcestringCAN or GPS
odometerValuenumber | nullCurrent reading in kilometres. null if no telemetry is available yet.
{
  "odometerSource": "GPS",
  "odometerValue": 154200.5
}

​
Error responses

StatusMeaning
401Missing or invalid token
403Token does not have permission to access this vehicle
404Vehicle not found
curl "https://api.telemax.com.au/api/v2/vehicles/88421/odometer" \
  -H "Authorization: Bearer <token>"

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from POST /api/v2/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping: API key tokens are scoped to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).

No refresh endpoint — re-authenticate with your API key when the token expires.

Path Parameters

​
id
integer
required

Response

200 OK — Current odometer reading and source.

​
odometerSource
enum<string>

Active odometer source. CAN means the reading comes from the vehicle CAN bus; GPS means it is GPS/GNSS-derived.

Available options:
CAN,
GPS
​
odometerValue
number | null

Current odometer reading in kilometres from the active source. null if no telemetry is available yet.