> ## Documentation Index
> Fetch the complete documentation index at: https://docs.telemax.com.au/llms.txt
> Use this file to discover all available pages before exploring further.

# Which endpoint do I need?

> Find the right Telemax API endpoint for your use case without reading every page.

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

***

## Tracking & location

| I want to…                                     | Endpoint                                                                                                                                                                             |
| ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| See where all my vehicles are right now        | [`POST /api/GetAllLastPositionData/{companyId}`](/v1/api-reference/post-get-all-last-position-data)                                                                                  |
| See where one vehicle is right now             | [`POST /api/GetLastPositionData`](/v1/api-reference/post-get-last-position-data)                                                                                                     |
| Find vehicles near a point on the map          | [`POST /api/GetNearest`](/v1/api-reference/post-get-nearest)                                                                                                                         |
| See the route a vehicle drove (with polyline)  | [`POST /api/GetReplayUserTime`](/v1/api-reference/post-get-replay-user-time) or [`POST /api/GetReplay`](/v1/api-reference/post-get-replay)                                           |
| Get raw GPS point history for a vehicle        | [`POST /api/GetPositionData`](/v1/api-reference/post-get-position-data)                                                                                                              |
| Check when a vehicle last had a GPS fix        | [`POST /api/GetAllLastTimeOnline/{companyId}`](/v1/api-reference/post-get-all-last-time-online) or [`POST /api/LastTimeOnline/{vehicleId}`](/v1/api-reference/post-last-time-online) |
| Ping a device for an immediate position update | [`POST /api/UpdateLocation`](/v1/api-reference/post-update-location)                                                                                                                 |

***

## Fleet & vehicle management

| I want to…                                    | Endpoint                                                                 |
| --------------------------------------------- | ------------------------------------------------------------------------ |
| Get my company ID (needed for most calls)     | [`POST /api/GetCompanies`](/v1/api-reference/post-get-companies)         |
| List all vehicles in the company              | [`POST /api/devices`](/v1/api-reference/post-devices)                    |
| Look up a vehicle ID from its SIM/device IMEI | [`GET /api/GetDeviceId/{imei}`](/v1/api-reference/get-device-id-by-imei) |
| Rename a vehicle                              | [`POST /api/SetVehicleName`](/v1/api-reference/post-set-vehicle-name)    |
| Update a vehicle's odometer reading           | [`POST /api/ChangeOdometer`](/v1/api-reference/post-change-odometer)     |

***

## Alerts

| I want to…                                        | Endpoint                                                                       |
| ------------------------------------------------- | ------------------------------------------------------------------------------ |
| Retrieve recent alerts (speeding, geofence, etc.) | [`POST /api/GetAlerts`](/v1/api-reference/post-get-alerts)                     |
| Mark one alert as handled                         | [`POST /api/SetAlertAsRead`](/v1/api-reference/post-set-alert-as-read)         |
| Clear all alerts for a company at once            | [`POST /api/SetAllAlertAsRead`](/v1/api-reference/post-set-all-alerts-as-read) |

***

## Vehicle health & diagnostics

| I want to…                                             | Endpoint                                                                                                  |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
| Get battery voltage and predicted health for the fleet | [`POST /api/GetCompanyVehiclesBatteryHealth`](/v1/api-reference/post-get-company-vehicles-battery-health) |
| Get OBD-II / CAN fault codes from a vehicle            | [`GET /api/devices/{id}/dtc-codes`](/v1/api-reference/get-devices-dtc-codes)                              |
| Get per-trip safety / risk scores for a vehicle        | [`POST /api/GetSafetyScore`](/v1/api-reference/post-get-safety-score)                                     |

***

## Remote commands

| I want to…                                  | Endpoint                                                          |
| ------------------------------------------- | ----------------------------------------------------------------- |
| Enable or disable the ignition remotely     | [`POST /api/SendIgnition`](/v1/api-reference/post-send-ignition)  |
| Lock or unlock a door (ATrack devices only) | [`POST /api/SendDoorLock`](/v1/api-reference/post-send-door-lock) |

***

## Setup & testing

| I want to…                                         | Endpoint                                                                                        |
| -------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| Authenticate and get a token (API key)             | [`POST /api/Authentication/token/api-key`](/v1/api-reference/post-authentication-token-api-key) |
| Authenticate and get a token (username + password) | [`POST /api/Authentication/token/user`](/v1/api-reference/post-authentication-token-user)       |
| Check the API is reachable (no auth needed)        | [`POST /api/Test`](/v1/api-reference/post-test)                                                 |

***

<Note>
  Most endpoints require a `companyId`. If you don't have it, call `POST /api/GetCompanies` first — the `Id` on the first result is your primary company ID.
</Note>