Alert configurations

Alert configurations (V2)

curl --request GET \
  --url https://api.telemax.com.au/v2/api/companies/{id}/alerts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.telemax.com.au/v2/api/companies/{id}/alerts', 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/v2/api/companies/{id}/alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/v2/api/companies/{id}/alerts"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.telemax.com.au/v2/api/companies/{id}/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "alertId": 3631,
      "alertType": "18",
      "companyId": 997,
      "alertName": "Service Reminder Overdue",
      "alertDescription": "862406071450635 [Mileage reminder test] is overdue.",
      "isAllFleet": false,
      "isAllTags": false,
      "units": [
        {
          "vehicleId": 22259,
          "name": "Fleet Vehicle 01",
          "imei": "862406071450635",
          "vin": "MPBCMFF70RX582825"
        }
      ],
      "tags": []
    }
  ],
  "totalResults": 9,
  "lastResultIndex": 2,
  "currentPage": 1,
  "numberOfPages": 5
}

{
  "type": "AUTHENTICATION",
  "code": "INVALID_CREDENTIALS",
  "description": "The provided API key is invalid or does not exist.",
  "requestId": "0HNLTALNU4DCO:00000004",
  "docUrl": "https://docs.telemax.com.au/errors/invalid-credentials"
}

{
  "type": "RESOURCE",
  "code": "NOT_FOUND",
  "description": "Company was not found.",
  "requestId": "0HNLTALNU4DD4:00000002",
  "docUrl": "https://docs.telemax.com.au/errors/not-found"
}

{
  "type": "RATE_LIMIT",
  "code": "RATE_LIMIT_EXCEEDED",
  "description": "Too many requests. Please slow down.",
  "requestId": "req_6d2f8b4a",
  "docUrl": "https://docs.telemax.com.au/errors/rate-limit-exceeded"
}

{
  "type": "SERVER_ERROR",
  "code": "INTERNAL_SERVER_ERROR",
  "description": "An unexpected error occurred. Please try again later.",
  "requestId": "req_1e5a3c7d",
  "docUrl": "https://docs.telemax.com.au/errors/internal-server-error"
}

GET

api

companies

{id}

alerts

Alert configurations (V2)

curl --request GET \
  --url https://api.telemax.com.au/v2/api/companies/{id}/alerts \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.telemax.com.au/v2/api/companies/{id}/alerts', 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/v2/api/companies/{id}/alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  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/v2/api/companies/{id}/alerts"

	req, _ := http.NewRequest("GET", 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))

}

require 'uri'
require 'net/http'

url = URI("https://api.telemax.com.au/v2/api/companies/{id}/alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "alertId": 3631,
      "alertType": "18",
      "companyId": 997,
      "alertName": "Service Reminder Overdue",
      "alertDescription": "862406071450635 [Mileage reminder test] is overdue.",
      "isAllFleet": false,
      "isAllTags": false,
      "units": [
        {
          "vehicleId": 22259,
          "name": "Fleet Vehicle 01",
          "imei": "862406071450635",
          "vin": "MPBCMFF70RX582825"
        }
      ],
      "tags": []
    }
  ],
  "totalResults": 9,
  "lastResultIndex": 2,
  "currentPage": 1,
  "numberOfPages": 5
}

{
  "type": "AUTHENTICATION",
  "code": "INVALID_CREDENTIALS",
  "description": "The provided API key is invalid or does not exist.",
  "requestId": "0HNLTALNU4DCO:00000004",
  "docUrl": "https://docs.telemax.com.au/errors/invalid-credentials"
}

{
  "type": "RESOURCE",
  "code": "NOT_FOUND",
  "description": "Company was not found.",
  "requestId": "0HNLTALNU4DD4:00000002",
  "docUrl": "https://docs.telemax.com.au/errors/not-found"
}

{
  "type": "RATE_LIMIT",
  "code": "RATE_LIMIT_EXCEEDED",
  "description": "Too many requests. Please slow down.",
  "requestId": "req_6d2f8b4a",
  "docUrl": "https://docs.telemax.com.au/errors/rate-limit-exceeded"
}

{
  "type": "SERVER_ERROR",
  "code": "INTERNAL_SERVER_ERROR",
  "description": "An unexpected error occurred. Please try again later.",
  "requestId": "req_1e5a3c7d",
  "docUrl": "https://docs.telemax.com.au/errors/internal-server-error"
}

Overview

Returns alert configuration records (definitions, not triggered events) for the company and its sub-companies. Each record includes the alertType discriminator (a numeric string), a human-readable alertName, the vehicles or tags the alert monitors, and whether it applies to the whole fleet. This is a new V2-only endpoint with no V1 equivalent.

Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

GET /v2/api/companies/{id}/alerts

Path parameters

integer

required

Company ID.

Query parameters

integer

default:"1"

Page number (1-based).

integer

default:"50"

Records per page.

Response

200 OK — PagedListResult<AlertConfigDto>

Field	Type	Description
alertId	integer	Alert definition ID — use this when linking to webhooks
alertType	string	Numeric string identifying the alert type (e.g. `"18"`). Use `alertName` and `alertDescription` for human-readable context.
companyId	integer	Company the alert belongs to
alertName	string	Alert name from the latest snapshot
alertDescription	string	Alert description from the latest snapshot
isAllFleet	boolean	`true` if the alert applies to all vehicles in the company
isAllTags	boolean	`true` if the alert applies to all tags in the company
units	array	Vehicles explicitly monitored (see below) — empty when `isAllFleet` is `true`
tags	string[]	Tags monitored — empty when `isAllTags` is `true`

Units items:

Field	Type	Description
vehicleId	integer \| null	Vehicle ID
name	string	Vehicle display name
imei	string \| null	Device IMEI
vin	string \| null	Vehicle VIN

Example response

{
  "items": [
    {
      "alertId": 101,
      "alertType": "18",
      "companyId": 12,
      "alertName": "Highway speeding",
      "alertDescription": "Speed over 110 km/h on highway zones",
      "isAllFleet": true,
      "isAllTags": false,
      "units": [],
      "tags": []
    }
  ],
  "currentPage": 1,
  "numberOfPages": 1,
  "totalResults": 1,
  "lastResultIndex": 0
}

Error responses

Status	Meaning
401	Missing or invalid token
404	Company not found or not in caller’s accessible hierarchy

curl "https://api.telemax.com.au/v2/api/companies/12/alerts?page=1&pageSize=50" \
  -H "Authorization: Bearer <token>"

Authorizations

Authorization

string

header

required

JWT Bearer token obtained from POST /v2/api/authentication/token/api-key.

Lifetime: ~24 hours (86,399 seconds). Cache the token and reuse it. Re-authenticate 5 minutes before expiry.

Scoping: API key tokens are scoped to the company the key belongs to and may restrict access to a vehicle allowlist and/or action set (see token claims).

No refresh endpoint — re-authenticate with your API key when the token expires.

Path Parameters

integer

required

Query Parameters

page

integer

default:1

pageSize

integer

default:50

Response

Successful response

Getting Started

Guides

Authentication

Companies & fleet

Vehicles

Vehicle commands

Alerts

Telemetry & replay

Insights & diagnostics

Webhooks

Reference

Overview

Endpoint

Path parameters

Query parameters

Response

Example response

Error responses

Authorizations

Path Parameters

Query Parameters

Response

​Overview

​Endpoint

​Path parameters

​Query parameters

​Response

​Example response

​Error responses

Authorizations

Path Parameters

Query Parameters

Response

Overview

Endpoint

Path parameters

Query parameters

Response

Example response

Error responses