Skip to main content
POST
/
api
/
GetAlerts
List Alerts
curl --request POST \
  --url https://api.telemax.com.au/api/GetAlerts \
  --header 'Authorization: Bearer <token>'
[
  {
    "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
  }
]

​
Overview

Returns up to num 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.
A V2 version of this endpoint is available: Alert records. New integrations should prefer V2.

​
Endpoint

POST /api/GetAlerts

​
Query parameters

​
compId
integer
required
Company id to scope alerts.
​
from
string (datetime)
required
Only alerts after this UTC instant.
​
num
integer
required
Maximum alerts to return (applied per type and globally after merge).

​
Response

200 OK — AlertDto[]
FieldTypeDescription
IdintegerAlert definition id
UtcTimedatetime | nullWhen triggered
UserTimedatetime | nullLocalized
UserTimeFormattedstringFormatted with user pattern
AlertTypeintegerAlert type discriminator
DescriptionstringFrom latest snapshot
VehicleIdintegerInternal vehicle id
VehicleNamestringResolved name
AddressstringReverse geocoded
LatnumberLatitude
LngnumberLongitude
IsReadbooleanRead state

​
Error responses

StatusMeaning
401Missing company or user id claim
404{ "error": "Company {compId} not found" }

Authorizations

​
Authorization
string
header
required

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

​
Content-Type
string

Standard and must keep as it is.

​
Authorization
string
required

Bearer your_token

Query Parameters

​
compId
integer
required

Company ID.

​
from
string
required

Starting date.

​
num
integer
required

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.

Required range: x <= 100

Response

Successful response with array of alert records

​
Id
integer

Alert ID

Example:

101

​
UtcTime
string<date-time> | null

Time in UTC

Example:

"2024-01-15T10:30:00Z"

​
UserTime
string<date-time> | null

Time in user timezone

Example:

"2024-01-15T12:30:00+02:00"

​
UserTimeFormated
string

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.

Example:

"15/01/2024 12:30:00"

​
AlertType
string

Alert type

Example:

"Overspeed"

​
Description
string

Description of the alert

Example:

"Vehicle exceeded speed limit by 25 km/h"

​
VehicleId
integer

Vehicle ID

Example:

12345

​
VehicleName
string

Name of the vehicle

Example:

"Fleet Vehicle 002"

​
Address
string

Address where the alert occurred

Example:

"456 Broadway, New York, NY 10012"

​
Lat
number<double>

Latitude

Example:

40.7218

​
Lng
number<double>

Longitude

Example:

-73.999

​
IsRead
boolean

Whether the alert has been read

Example:

false