Skip to main content
GET
/
api
/
v2
/
companies
/
{id}
/
alert-records
Alert records (V2)
curl --request GET \
  --url https://api.telemax.com.au/api/v2/companies/{id}/alert-records \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": 4126,
      "utcTime": "2026-05-26T03:40:40",
      "userTime": "2026-05-26T13:40:40",
      "userTimeFormatted": "26/05/2026 01:40:40 PM",
      "alertType": 7,
      "description": "",
      "vehicleId": 88421,
      "vehicleName": "Delivery Van 07",
      "address": "Hume Hwy, Campbelltown NSW 2560",
      "lat": -34.065,
      "lng": 150.815,
      "isRead": true
    }
  ],
  "totalResults": 7,
  "lastResultIndex": 7,
  "currentPage": 1,
  "numberOfPages": 1
}

Overview

Returns triggered alert records for the company after a given UTC timestamp, ordered newest first.
The V1 version of this endpoint is List alerts. V2 uses proper pagination instead of the num cap.
Rate limit: 20 requests per 60 seconds per token.

Endpoint

GET /api/v2/companies/{id}/alert-records

Path parameters

id
integer
required
Company ID.

Query parameters

from
string (datetime)
required
Return only alerts triggered after this UTC timestamp (ISO 8601).
num
integer
required
Maximum total records to consider (applied before pagination).
page
integer
default:"1"
Page number (1-based).
pageSize
integer
default:"50"
Records per page.

Response

200 OKPagedListResult<AlertDto>
FieldTypeDescription
idintegerAlert definition ID
utcTimedatetime | nullWhen the alert was triggered (UTC)
userTimedatetime | nullTrigger time in the user’s timezone
userTimeFormattedstringFormatted trigger time string
alertTypeintegerAlert type discriminator (see note below)
descriptionstringAlert description from the latest snapshot
vehicleIdintegerVehicle ID
vehicleNamestringVehicle display name
addressstringReverse-geocoded address at trigger location
latnumberLatitude at trigger
lngnumberLongitude at trigger
isReadbooleanWhether the alert has been marked read
AlertType is an integer discriminator. Use GET /api/v2/companies/{id}/alerts to retrieve alert configurations, which include the string AlertType label for each alert definition.

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/alert-records?from=2026-04-01T00:00:00Z&num=200&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

from
string<date-time>
num
integer
page
integer
default:1
pageSize
integer
default:50

Response

Successful response