Skip to main content
GET
/
api
/
v2
/
companies
/
{id}
/
alerts
Alert configurations (V2)
curl --request GET \
  --url https://api.telemax.com.au/api/v2/companies/{id}/alerts \
  --header 'Authorization: Bearer <token>'
{
  "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
}

​
Overview

Returns alert configuration records (definitions, not triggered events) for the company and its sub-companies. Each record includes the human-readable AlertType string, 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: 20 requests per 60 seconds per token.

​
Endpoint

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

​
Path parameters

​
id
integer
required
Company ID.

​
Query parameters

​
page
integer
default:"1"
Page number (1-based).
​
pageSize
integer
default:"50"
Records per page.

​
Response

200 OK — PagedListResult<AlertConfigDto>
FieldTypeDescription
alertIdintegerAlert definition ID — use this when linking to webhooks
alertTypestringHuman-readable alert type label (e.g. "Speeding", "Geofence")
companyIdintegerCompany the alert belongs to
alertNamestringAlert name from the latest snapshot
alertDescriptionstringAlert description from the latest snapshot
isAllFleetbooleantrue if the alert applies to all vehicles in the company
isAllTagsbooleantrue if the alert applies to all tags in the company
unitsarrayVehicles explicitly monitored (see below) — empty when isAllFleet is true
tagsstring[]Tags monitored — empty when isAllTags is true
Units items:
FieldTypeDescription
vehicleIdinteger | nullLegacy vehicle ID
namestringVehicle display name
imeistring | nullDevice IMEI
vinstring | nullVehicle VIN

​
Example response

{
  "items": [
    {
      "alertId": 101,
      "alertType": "Speeding",
      "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

StatusMeaning
401Token not scoped to this company
403Company not in caller’s accessible hierarchy
404Company not found
curl "https://api.telemax.com.au/api/v2/companies/12/alerts?page=1&pageSize=50" \
  -H "Authorization: Bearer <token>"

Authorizations

​
Authorization
string
header
required

JWT Bearer token obtained from POST /api/v2/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

​
id
integer
required

Query Parameters

​
page
integer
default:1
​
pageSize
integer
default:50

Response

Successful response