Quickstart

Prerequisites — Create an API Key

Before making any API calls, you’ll need an API key. Head to the Telemax Webhooks and API Key section in the Telemax dashboard to create your own key.

Navigate to Telemax Dashboard → Webhooks and API Key to generate a new API key. Copy the key and keep it secure — you’ll use it in the step below.

Step 1 — Get an access token

Interactive reference: API key token · Dashboard user token.

curl -s -X POST "https://api.telemax.com.au/api/Authentication/token/api-key" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --data-urlencode "apiKey=a3f1c2b4-5d6e-7890-abcd-ef1234567890"

const r = await fetch(
  "https://api.telemax.com.au/api/Authentication/token/api-key",
  {
    method: "POST",
    headers: { "Content-Type": "application/x-www-form-urlencoded" },
    body: new URLSearchParams({
      apiKey: "a3f1c2b4-5d6e-7890-abcd-ef1234567890",
    }),
  },
);
console.log(await r.json());

import requests
r = requests.post(
    'https://api.telemax.com.au/api/Authentication/token/api-key',
    data={'apiKey': 'a3f1c2b4-5d6e-7890-abcd-ef1234567890'},
)
print(r.json())

200 OK response shape:

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 86399.0
}

Step 2 — Call an authenticated endpoint

Almost all routes use POST with parameters in the query string (not JSON body) — see the architecture note for details. The only GET endpoints are GetDeviceId and devices/{deviceId}/dtc-codes. Example: GetLastPositionData for legacy vehicle 88421:

curl -s -X POST "https://api.telemax.com.au/api/GetLastPositionData?id=88421" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."

200 OK returns a PositionDto JSON object (see Request & response) with fields such as Lat, Lng, UtcTime, DeviceId (legacy id), IMEI, etc.

Common first errors

Symptom	Cause	Fix
`401` with no body	Missing or invalid `Authorization` header	Obtain a fresh token; prefix with `Bearer`
`401` from token endpoint	Wrong password or unknown API key	Verify credentials; GUID keys must exist in `ApiKeys` non-deleted
`400` from token endpoint	API key invalid for legacy path	Legacy keys must resolve via the configured legacy API service
`404` on data route	Vehicle legacy id unknown	Confirm vehicle exists; use GetDeviceId if you only have IMEI
Empty `access_token`	Parsing error	Ensure `Content-Type` is form-urlencoded, not JSON

Getting Started

Guides

Authentication

Companies & fleet

Telemetry & replay

Alerts

Insights & diagnostics

Vehicle commands

Operations & health

Reference

Prerequisites — Create an API Key

Step 1 — Get an access token

Step 2 — Call an authenticated endpoint

Common first errors

​Prerequisites — Create an API Key

​Step 1 — Get an access token

​Step 2 — Call an authenticated endpoint

​Common first errors

Prerequisites — Create an API Key

Step 1 — Get an access token

Step 2 — Call an authenticated endpoint

Common first errors