# Telemax Docs

## Docs

- [Welcome](https://docs.telemax.com.au/api-welcome.md)
- [Lookup by IMEI](https://docs.telemax.com.au/v1/api-reference/get-device-id-by-imei.md): Resolve a device IMEI to legacy vehicle id and name.
- [DTC codes](https://docs.telemax.com.au/v1/api-reference/get-devices-dtc-codes.md): Diagnostic trouble codes from the latest stored DTC record.
- [API key token](https://docs.telemax.com.au/v1/api-reference/post-authentication-token-api-key.md): Authenticate with an API key (GUID or legacy); receive a JWT.
- [Dashboard user token](https://docs.telemax.com.au/v1/api-reference/post-authentication-token-user.md): Authenticate a dashboard user with username and password; receive a JWT.
- [Change odometer](https://docs.telemax.com.au/v1/api-reference/post-change-odometer.md): Update odometer for a vehicle (legacy id).
- [Get device positions](https://docs.telemax.com.au/v1/api-reference/post-devices.md): Last positions for vehicles in the company tree, optionally filtered by vehicle ids.
- [List alerts](https://docs.telemax.com.au/v1/api-reference/post-get-alerts.md): List recent alerts for a company.
- [Fleet last positions](https://docs.telemax.com.au/v1/api-reference/post-get-all-last-position-data.md): Fleet-wide last positions for all vehicles in a company.
- [Get fleet last online](https://docs.telemax.com.au/v1/api-reference/post-get-all-last-time-online.md): Last heartbeat per vehicle in a company.
- [Company tree](https://docs.telemax.com.au/v1/api-reference/post-get-companies.md): Return the caller’s company hierarchy, timezone, and date format.
- [Battery health](https://docs.telemax.com.au/v1/api-reference/post-get-company-vehicles-battery-health.md): Paged battery prediction rows for vehicles in the JWT company.
- [Vehicle Position](https://docs.telemax.com.au/v1/api-reference/post-get-last-position-data.md): Latest known position for one vehicle (legacy id).
- [Nearest vehicles](https://docs.telemax.com.au/v1/api-reference/post-get-nearest.md): Find vehicles nearest to a coordinate, with optional count and radius.
- [Position history](https://docs.telemax.com.au/v1/api-reference/post-get-position-data.md): Minimal position points in a UTC time window.
- [Trip Replay (UTC)](https://docs.telemax.com.au/v1/api-reference/post-get-replay.md): Trip replay for a vehicle between two UTC datetimes.
- [Trip replay (user time)](https://docs.telemax.com.au/v1/api-reference/post-get-replay-user-time.md): Trip replay for a vehicle using the user’s time zone context.
- [Safety score](https://docs.telemax.com.au/v1/api-reference/post-get-safety-score.md): Trip safety score for a legacy vehicle over a date range.
- [Get vehicle last online](https://docs.telemax.com.au/v1/api-reference/post-last-time-online.md): Last heartbeat time and seconds since, for one vehicle.
- [Send Door Lock](https://docs.telemax.com.au/v1/api-reference/post-send-door-lock.md): Send door lock/unlock for ATrack protocol family via SMS.
- [Remote ignition](https://docs.telemax.com.au/v1/api-reference/post-send-ignition.md): Send ignition on/off via SMS and GPRS when IMEI exists.
- [Mark alert read](https://docs.telemax.com.au/v1/api-reference/post-set-alert-as-read.md): Mark one alert record as read.
- [Mark all alerts read](https://docs.telemax.com.au/v1/api-reference/post-set-all-alerts-as-read.md): Mark all alerts as read for companies under the caller’s tree.
- [Rename vehicle](https://docs.telemax.com.au/v1/api-reference/post-set-vehicle-name.md): Rename a vehicle by legacy id.
- [Health check](https://docs.telemax.com.au/v1/api-reference/post-test.md): Anonymous connectivity check returning plain text.
- [Request location update](https://docs.telemax.com.au/v1/api-reference/post-update-location.md): Validate vehicle access and IMEI; request a location update.
- [Authentication](https://docs.telemax.com.au/v1/authentication.md): JWT Bearer tokens via user credentials or API key — form-encoded token endpoints and claims.
- [Changelog](https://docs.telemax.com.au/v1/changelog.md): Version history, deprecation notices, and the Telemax API deprecation policy.
- [Base URL & environments](https://docs.telemax.com.au/v1/environments.md): Where the External API is hosted and how to point clients at the right environment.
- [Error handling](https://docs.telemax.com.au/v1/errors.md): Standardised error response model, HTTP status codes, example responses, and retry guidance for the Telemax External API.
- [Glossary](https://docs.telemax.com.au/v1/glossary.md): Plain-English definitions for terms used throughout the Telemax API documentation.
- [Alert Monitoring Pipeline](https://docs.telemax.com.au/v1/guides/alert-monitoring.md): Poll, filter, deduplicate, and acknowledge vehicle alerts using GetAlerts, SetAlertAsRead, and SetAllAlertsAsRead.
- [Real-Time Fleet Tracking](https://docs.telemax.com.au/v1/guides/fleet-tracking.md): Poll fleet positions and render live vehicle locations on a map using GetAllLastPositionData and GetLastPositionData.
- [Trip Replay](https://docs.telemax.com.au/v1/guides/trip-replay.md): Fetch trip waypoints, decode polylines, and render trips on Google Maps or Leaflet.
- [Vehicle Health Dashboard](https://docs.telemax.com.au/v1/guides/vehicle-diagnostics.md): Combine live position, battery predictions, and DTC codes into a single per-vehicle health view using GetLastPositionData, GetCompanyVehiclesBatteryHealth, and devices/{id}/dtc-codes.
- [Introduction](https://docs.telemax.com.au/v1/introduction.md): Overview of the Telemax External API for fleet telemetry, vehicle commands, and integrations.
- [Quickstart](https://docs.telemax.com.au/v1/quickstart.md): Obtain a JWT and call your first External API route in minutes.
- [Known issues & legacy fields](https://docs.telemax.com.au/v1/quirks.md): Unit conventions and backward-compatibility notes for the Telemax External API.
- [Request & response format](https://docs.telemax.com.au/v1/request-response.md): JSON conventions, query vs body, datetime serialization, and pagination for the V1 External API.
- [Which endpoint do I need?](https://docs.telemax.com.au/v1/which-endpoint.md): Find the right Telemax API endpoint for your use case without reading every page.
- [Delete webhook](https://docs.telemax.com.au/v2/api-reference/delete-webhooks-id.md): Soft-deletes a webhook and stops all future deliveries.
- [Battery health](https://docs.telemax.com.au/v2/api-reference/get-battery-health.md): Paginated battery health scores and diagnostics for vehicles in the authenticated company.
- [List companies](https://docs.telemax.com.au/v2/api-reference/get-companies.md): Returns a paginated list of companies accessible to the authenticated token.
- [Alert records](https://docs.telemax.com.au/v2/api-reference/get-companies-id-alert-records.md): Paginated list of triggered alert records for the company.
- [Alert configurations](https://docs.telemax.com.au/v2/api-reference/get-companies-id-alerts.md): Paginated list of alert definitions for the company and its sub-companies.
- [Fleet last positions](https://docs.telemax.com.au/v2/api-reference/get-companies-id-vehicles-last-position.md): Last known position for every vehicle in the company.
- [Fleet last-time-online](https://docs.telemax.com.au/v2/api-reference/get-companies-id-vehicles-last-time-online.md): Last-seen timestamps for all vehicles in the company.
- [Nearest vehicles](https://docs.telemax.com.au/v2/api-reference/get-companies-id-vehicles-nearest.md): Returns vehicles nearest to a geographic coordinate within the company.
- [Trip replay](https://docs.telemax.com.au/v2/api-reference/get-replay-id.md): Paginated trip replay for a vehicle within a date range.
- [Engine codes](https://docs.telemax.com.au/v2/api-reference/get-vehicles-id-engine-codes.md): Enriched engine/diagnostic codes for a vehicle with full AI analysis, severity, and detection location.
- [Last online](https://docs.telemax.com.au/v2/api-reference/get-vehicles-id-last-online.md): Returns the last time a vehicle was online and how long ago that was.
- [Last position](https://docs.telemax.com.au/v2/api-reference/get-vehicles-id-last-position.md): Returns the last known position for a single vehicle.
- [Get odometer](https://docs.telemax.com.au/v2/api-reference/get-vehicles-id-odometer.md): Returns the current odometer reading and its source for a vehicle.
- [Position history](https://docs.telemax.com.au/v2/api-reference/get-vehicles-id-positions.md): Paginated historical position records for a vehicle within a date range.
- [Device ID from IMEI](https://docs.telemax.com.au/v2/api-reference/get-vehicles-imei-device-ids.md): Resolves a device IMEI to vehicle ID and name.
- [Vehicle info](https://docs.telemax.com.au/v2/api-reference/get-vehicles-info.md): Look up full vehicle metadata by IMEI, vehicle ID, or VIN. Returns all available Vincario decode data as label/value pairs.
- [List webhooks](https://docs.telemax.com.au/v2/api-reference/get-webhooks.md): Returns a paginated list of webhooks for the authenticated company.
- [Get webhook](https://docs.telemax.com.au/v2/api-reference/get-webhooks-id.md): Returns a single webhook by ID.
- [API key token](https://docs.telemax.com.au/v2/api-reference/post-authentication-token-api-key.md): Exchange a company API key for a JWT.
- [List vehicles](https://docs.telemax.com.au/v2/api-reference/post-vehicles-list.md): Returns last-known positions for a specific set of 1–50 vehicles.
- [Create webhook](https://docs.telemax.com.au/v2/api-reference/post-webhooks.md): Creates a new webhook and returns the HMAC signing secret.
- [Link alert](https://docs.telemax.com.au/v2/api-reference/post-webhooks-id-link-alert.md): Links an alert configuration to an existing webhook.
- [Update alert read status](https://docs.telemax.com.au/v2/api-reference/put-alerts-id-update-read-status.md): Marks a single alert record as read or unread.
- [Mark all alerts read](https://docs.telemax.com.au/v2/api-reference/put-companies-id-set-all-alerts-read.md): Marks all alert records for the company as read.
- [Rename vehicle](https://docs.telemax.com.au/v2/api-reference/put-vehicles-id-name.md): Updates the display name of a vehicle.
- [Update odometer](https://docs.telemax.com.au/v2/api-reference/put-vehicles-id-odometer.md): Sets the GPS odometer reading for a vehicle.
- [Update odometer source](https://docs.telemax.com.au/v2/api-reference/put-vehicles-id-odometer-source.md): Sets the odometer source for a vehicle to CAN or GPS.
- [Refresh position](https://docs.telemax.com.au/v2/api-reference/put-vehicles-id-position-refresh.md): Triggers a location update request for a vehicle.
- [Update webhook](https://docs.telemax.com.au/v2/api-reference/put-webhooks-id.md): Updates the URL, active state, and linked alerts of a webhook.
- [Authentication](https://docs.telemax.com.au/v2/authentication.md): JWT Bearer tokens via API key — form-encoded token endpoint and claims.
- [Changelog](https://docs.telemax.com.au/v2/changelog.md): Version history, deprecation notices, and the Telemax API deprecation policy.
- [Base URL & environments](https://docs.telemax.com.au/v2/environments.md): Where the External API is hosted and how to point clients at the right environment.
- [Error handling](https://docs.telemax.com.au/v2/errors.md): Standardised error response model, HTTP status codes, example responses, and retry guidance for the Telemax External API.
- [Glossary](https://docs.telemax.com.au/v2/glossary.md): Plain-English definitions for terms used throughout the Telemax API documentation.
- [Alert Monitoring Pipeline](https://docs.telemax.com.au/v2/guides/alert-monitoring.md): Fetch, filter, and acknowledge vehicle alerts using the V2 alert-records, alerts, and update-read-status endpoints.
- [Trip Replay](https://docs.telemax.com.au/v2/guides/trip-replay.md): Fetch trip waypoints, decode polylines, and render trips on Google Maps or Leaflet using the V2 replay endpoint.
- [Vehicle Health Dashboard](https://docs.telemax.com.au/v2/guides/vehicle-diagnostics.md): Combine live position, battery predictions, and engine codes into a single per-vehicle health view using V2 endpoints.
- [Introduction](https://docs.telemax.com.au/v2/introduction.md): Overview of the Telemax External API for fleet telemetry, vehicle commands, and integrations.
- [Quickstart](https://docs.telemax.com.au/v2/quickstart.md): Obtain a JWT and make your first V2 API calls in minutes.
- [Known issues & legacy fields](https://docs.telemax.com.au/v2/quirks.md): Unit conventions and backward-compatibility notes for the Telemax External API.
- [Request & response format](https://docs.telemax.com.au/v2/request-response.md): JSON conventions, query vs body, datetime serialization, pagination, and rate limiting for the V2 External API.
- [Webhooks overview](https://docs.telemax.com.au/v2/webhooks-overview.md): Subscribe to real-time alert events with HMAC-signed HTTP delivery.
- [Which endpoint do I need?](https://docs.telemax.com.au/v2/which-endpoint.md): Find the right V2 Telemax API endpoint for your use case without reading every page.

## OpenAPI Specs

- [openapi](https://docs.telemax.com.au/openapi.yaml)
- [webhooks](https://docs.telemax.com.au/webhooks.yaml)