curl --request POST \
--url https://api.telemax.com.au/api/GetAlerts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.telemax.com.au/api/GetAlerts"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.telemax.com.au/api/GetAlerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.telemax.com.au/api/GetAlerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.telemax.com.au/api/GetAlerts"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.telemax.com.au/api/GetAlerts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telemax.com.au/api/GetAlerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": 101,
"utcTime": "2024-01-15T10:30:00Z",
"userTime": "2024-01-15T12:30:00+02:00",
"userTimeFormatted": "15/01/2024 12:30:00",
"alertType": "Overspeed",
"description": "Vehicle exceeded speed limit by 25 km/h",
"vehicleId": 12345,
"vehicleName": "Fleet Vehicle 002",
"address": "456 Broadway, New York, NY 10012",
"lat": 40.7218,
"lng": -73.999,
"isRead": false
}
]{
"type": "AUTHENTICATION",
"code": "TOKEN_EXPIRED",
"description": "The access token has expired. Request a new token using /api/authentication/token/user or /api/authentication/token/api-key.",
"requestId": "req_7f3a2b1c",
"docUrl": "https://docs.telemax.com.au/errors#token-expired"
}{
"type": "AUTHORIZATION",
"code": "COMPANY_ACCESS_DENIED",
"description": "Your token does not grant access to company 99. Ensure you are using a token issued for this company.",
"requestId": "req_4a1d9e2f",
"docUrl": "https://docs.telemax.com.au/errors#company-access-denied"
}{
"type": "NOT_FOUND",
"code": "VEHICLE_NOT_FOUND",
"description": "Vehicle with ID 9999 was not found.",
"requestId": "req_2b8c1a5d",
"docUrl": "https://docs.telemax.com.au/errors#not-found"
}{
"type": "VALIDATION",
"code": "INVALID_DATE_FORMAT",
"description": "The 'from' parameter '2025-13-45' is not a valid ISO 8601 date-time string.",
"requestId": "req_9f3e7c1b",
"docUrl": "https://docs.telemax.com.au/errors#invalid-parameter"
}{
"type": "RATE_LIMIT",
"code": "RATE_LIMIT_EXCEEDED",
"description": "Too many requests. Wait 30 seconds before retrying.",
"requestId": "req_6d2f8b4a",
"docUrl": "https://docs.telemax.com.au/errors#rate-limit"
}{
"type": "SERVER_ERROR",
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred. Please try again or contact support with the requestId.",
"requestId": "req_1e5a3c7d",
"docUrl": "https://docs.telemax.com.au/errors#server-error"
}List alerts
List recent alerts for a company.
curl --request POST \
--url https://api.telemax.com.au/api/GetAlerts \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.telemax.com.au/api/GetAlerts"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.telemax.com.au/api/GetAlerts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.telemax.com.au/api/GetAlerts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.telemax.com.au/api/GetAlerts"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.telemax.com.au/api/GetAlerts")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.telemax.com.au/api/GetAlerts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": 101,
"utcTime": "2024-01-15T10:30:00Z",
"userTime": "2024-01-15T12:30:00+02:00",
"userTimeFormatted": "15/01/2024 12:30:00",
"alertType": "Overspeed",
"description": "Vehicle exceeded speed limit by 25 km/h",
"vehicleId": 12345,
"vehicleName": "Fleet Vehicle 002",
"address": "456 Broadway, New York, NY 10012",
"lat": 40.7218,
"lng": -73.999,
"isRead": false
}
]{
"type": "AUTHENTICATION",
"code": "TOKEN_EXPIRED",
"description": "The access token has expired. Request a new token using /api/authentication/token/user or /api/authentication/token/api-key.",
"requestId": "req_7f3a2b1c",
"docUrl": "https://docs.telemax.com.au/errors#token-expired"
}{
"type": "AUTHORIZATION",
"code": "COMPANY_ACCESS_DENIED",
"description": "Your token does not grant access to company 99. Ensure you are using a token issued for this company.",
"requestId": "req_4a1d9e2f",
"docUrl": "https://docs.telemax.com.au/errors#company-access-denied"
}{
"type": "NOT_FOUND",
"code": "VEHICLE_NOT_FOUND",
"description": "Vehicle with ID 9999 was not found.",
"requestId": "req_2b8c1a5d",
"docUrl": "https://docs.telemax.com.au/errors#not-found"
}{
"type": "VALIDATION",
"code": "INVALID_DATE_FORMAT",
"description": "The 'from' parameter '2025-13-45' is not a valid ISO 8601 date-time string.",
"requestId": "req_9f3e7c1b",
"docUrl": "https://docs.telemax.com.au/errors#invalid-parameter"
}{
"type": "RATE_LIMIT",
"code": "RATE_LIMIT_EXCEEDED",
"description": "Too many requests. Wait 30 seconds before retrying.",
"requestId": "req_6d2f8b4a",
"docUrl": "https://docs.telemax.com.au/errors#rate-limit"
}{
"type": "SERVER_ERROR",
"code": "INTERNAL_ERROR",
"description": "An unexpected error occurred. Please try again or contact support with the requestId.",
"requestId": "req_1e5a3c7d",
"docUrl": "https://docs.telemax.com.au/errors#server-error"
}Overview
Returns up tonum alert records across alert record types, after from (UTC), for alerts belonging to companies in the caller’s tree when compId matches an allowed company.
Endpoint
POST /api/GetAlerts
Query parameters
Response
200 OK —AlertDto[]
| Field | Type | Description |
|---|---|---|
| Id | integer | Alert definition id |
| UtcTime | datetime | null | When triggered |
| UserTime | datetime | null | Localized |
| UserTimeFormatted | string | Formatted with user pattern |
| AlertType | integer | Alert type discriminator |
| Description | string | From latest snapshot |
| VehicleId | integer | Internal vehicle id |
| VehicleName | string | Resolved name |
| Address | string | Reverse geocoded |
| Lat | number | Latitude |
| Lng | number | Longitude |
| IsRead | boolean | Read state |
Error responses
| Status | Meaning |
|---|---|
| 401 | Missing company or user id claim |
| 404 | { "error": "Company {compId} not found" } |
Authorizations
JWT Bearer token obtained from POST /api/authentication/token/user or POST /api/authentication/token/api-key.
Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.
Scoping:
- User tokens are scoped to a single company.
- API key tokens may restrict access to a vehicle allowlist and/or action set (see token claims).
No refresh endpoint — re-authenticate with your credentials when the token expires.
Headers
Standard and must keep as it is.
Bearer your_token
Query Parameters
Company ID.
Starting date.
Maximum number of alerts to return (legacy max-count parameter). Results are ordered by date descending. There is no total count or page cursor — pagination will be added in a future release. Recommended maximum: 100.
x <= 100Response
Successful response with array of alert records
Alert ID
101
Time in UTC
"2024-01-15T10:30:00Z"
Time in user timezone
"2024-01-15T12:30:00+02:00"
Timestamp in the user's configured date-time format (e.g. "15/01/2024 12:30:00"). Note: The field name is intentionally misspelled (UserTimeFormated, single 't') to preserve backward compatibility.
"15/01/2024 12:30:00"
Alert type
"Overspeed"
Description of the alert
"Vehicle exceeded speed limit by 25 km/h"
Vehicle ID
12345
Name of the vehicle
"Fleet Vehicle 002"
Address where the alert occurred
"456 Broadway, New York, NY 10012"
Latitude
40.7218
Longitude
-73.999
Whether the alert has been read
false
Was this page helpful?