> ## 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 V2 Telemax API endpoint for your use case without reading every page.

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.

<Note>
  All V2 endpoints use RESTful HTTP methods (`GET`, `POST`, `PUT`, `DELETE`) with parameters in the path or query string. V2 endpoints are at `/v2/api/...`. If you need the older V1 endpoints, switch to the **V1 (Legacy)** version in the version selector.
</Note>

***

## Tracking & location

| I want to…                                  | Endpoint                                                                                                                                                                                                           |
| ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| See where all my vehicles are right now     | [`GET /v2/api/companies/{id}/vehicles/last-position`](/v2/api-reference/get-companies-id-vehicles-last-position)                                                                                                   |
| See where one vehicle is right now          | [`GET /v2/api/vehicles/{id}/last-position`](/v2/api-reference/get-vehicles-id-last-position)                                                                                                                       |
| Find vehicles near a point on the map       | [`GET /v2/api/companies/{id}/vehicles/nearest`](/v2/api-reference/get-companies-id-vehicles-nearest)                                                                                                               |
| See the route a vehicle drove (trip replay) | [`GET /v2/api/replay/{id}`](/v2/api-reference/get-replay-id)                                                                                                                                                       |
| Get raw GPS point history for a vehicle     | [`GET /v2/api/vehicles/{id}/positions`](/v2/api-reference/get-vehicles-id-positions)                                                                                                                               |
| Check when a vehicle last had a GPS fix     | [`GET /v2/api/vehicles/{id}/last-online`](/v2/api-reference/get-vehicles-id-last-online) or [`GET /v2/api/companies/{id}/vehicles/last-time-online`](/v2/api-reference/get-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`](/v2/api-reference/get-companies)                                 |
| Search a set of vehicles                     | [`POST /v2/api/vehicles/list`](/v2/api-reference/post-vehicles-list)                       |
| Look up vehicle metadata by IMEI, ID, or VIN | [`GET /v2/api/vehicles/info`](/v2/api-reference/get-vehicles-info)                         |
| Convert an IMEI to a vehicle ID              | [`GET /v2/api/vehicles/{imei}/device-ids`](/v2/api-reference/get-vehicles-imei-device-ids) |
| Rename a vehicle                             | [`PUT /v2/api/vehicles/{id}/name`](/v2/api-reference/put-vehicles-id-name)                 |
| Update a vehicle's odometer reading          | [`PUT /v2/api/vehicles/{id}/odometer`](/v2/api-reference/put-vehicles-id-odometer)         |

***

## Alerts

| I want to…                                               | Endpoint                                                                                                   |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| Retrieve recent alert records (speeding, geofence, etc.) | [`GET /v2/api/companies/{id}/alert-records`](/v2/api-reference/get-companies-id-alert-records)             |
| List alert configurations (definitions, not events)      | [`GET /v2/api/companies/{id}/alerts`](/v2/api-reference/get-companies-id-alerts)                           |
| Mark one alert record as read or unread                  | [`PUT /v2/api/alerts/{id}/{date}/update-read-status`](/v2/api-reference/put-alerts-id-update-read-status)  |
| Mark all alert records for a company as read             | [`PUT /v2/api/companies/{id}/set-all-alerts-read`](/v2/api-reference/put-companies-id-set-all-alerts-read) |

***

## Vehicle health & diagnostics

| I want to…                                                                       | Endpoint                                                                                   |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| Get battery voltage and predicted health for the fleet *(select customers only)* | [`GET /v2/api/battery-health`](/v2/api-reference/get-battery-health)                       |
| Get OBD-II / CAN fault codes from a vehicle                                      | [`GET /v2/api/vehicles/{id}/engine-codes`](/v2/api-reference/get-vehicles-id-engine-codes) |

***

## Webhooks

| I want to…                          | Endpoint                                                                                                                                  |
| ----------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Subscribe to real-time alert events | [`POST /v2/api/webhooks`](/v2/api-reference/post-webhooks)                                                                                |
| List my webhook subscriptions       | [`GET /v2/api/webhooks`](/v2/api-reference/get-webhooks)                                                                                  |
| Update or delete a webhook          | [`PUT /v2/api/webhooks/{id}`](/v2/api-reference/put-webhooks-id) · [`DELETE /v2/api/webhooks/{id}`](/v2/api-reference/delete-webhooks-id) |
| Link an alert type to a webhook     | [`POST /v2/api/webhooks/{id}/link-alert`](/v2/api-reference/post-webhooks-id-link-alert)                                                  |

***

## Authentication

| I want to…                   | Endpoint                                                                                           |
| ---------------------------- | -------------------------------------------------------------------------------------------------- |
| Authenticate with an API key | [`POST /v2/api/authentication/token/api-key`](/v2/api-reference/post-authentication-token-api-key) |

***

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