Skip to main content
GET
Alert records (V2)

Overview

Returns triggered alert records, newest first, for every company the token can read (its own company and its direct sub-companies), whatever {id} is. {id} must be one of those companies, otherwise the call returns 404; a deeper or cancelled sub-company also returns 404. Records of deleted alert definitions are not returned.
The V1 version of this endpoint is List alerts.
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

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

Path parameters

integer
required
Company ID.

Query parameters

string (datetime)
Return only records triggered strictly after this time (UTC, ISO 8601). Optional: when omitted, every stored record is considered. To poll for new records, see Alert monitoring.
integer
Required in practice, 1 or more: omitted or 0 returns nothing. The limit applies per alert type: the newest num records of each type are taken, then merged newest first and paged. So only the first num records of the merged list are complete; set num to at least page × pageSize for the deepest page you read. totalResults counts only this capped set. A negative num returns 500.
integer
default:"1"
Page number (1-based).
integer
default:"50"
Records per page, 1–100.

Response

200 OK — PagedListResult<AlertDto>

Alert types

Only these 10 alert types are returned. alertType is the integer; the names match alertType in Alert configurations and the “alertType in GET …/alerts” column of the webhook type tables.
  • Device Disconnected (1), Device Reconnected (2), Doors Unlocked (13), Tire Pressure (14) and Road Surface (19) are not returned here; they are available through webhooks.
  • The records of Charging (15), Exceed RPM (16), Exceed Engine Temperature (17) and Driving after dark (20) are neither returned here nor delivered by webhooks; their definitions still appear in Alert configurations.
  • Reminders (18) are never returned.
To get a record’s alert name, call Alert configurations with your level-0 company ID (see List companies) and match alertId to id. Take the type from alertType here: if a definition’s type was later edited, its older records keep the old type, while Alert configurations shows the new one.

Error responses

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 by the key's company and its action set; see Token scoping.

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

Path Parameters

id
integer
required

Query Parameters

from
string<date-time>

Records triggered strictly after this time (UTC). Optional; when omitted, every stored record is considered.

num
integer

Required in practice: omitted or 0 returns nothing, and a negative value returns 500. Applied per alert type, so only the first num records of the merged, newest-first list are complete.

Required range: x >= 1
page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 100

Response

Successful response