Alert records (V2)
Companies & fleet
Alert records
Paginated list of triggered alert records for the company.
GET
Alert records (V2)
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
Company ID.
Query parameters
Return only alerts triggered after this UTC timestamp (ISO 8601).
Maximum total records to consider (applied before pagination).
Page number (1-based).
Records per page.
Response
200 OK —PagedListResult<AlertDto>
| Field | Type | Description |
|---|---|---|
| id | integer | Alert definition ID |
| utcTime | datetime | null | When the alert was triggered (UTC) |
| userTime | datetime | null | Trigger time in the user’s timezone |
| userTimeFormatted | string | Formatted trigger time string |
| alertType | integer | Alert type discriminator (see note below) |
| description | string | Alert description from the latest snapshot |
| vehicleId | integer | Vehicle ID |
| vehicleName | string | Vehicle display name |
| address | string | Reverse-geocoded address at trigger location |
| lat | number | Latitude at trigger |
| lng | number | Longitude at trigger |
| isRead | boolean | Whether 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
| Status | Meaning |
|---|---|
| 401 | Token not scoped to this company |
| 403 | Company not in caller’s accessible hierarchy |
| 404 | Company not found |
Authorizations
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
Response
Successful response