Skip to main content
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: 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 alerts triggered after this UTC timestamp (ISO 8601). Omitting returns an empty result set.
integer
Maximum total records to consider (applied before pagination). Omitting returns an empty result set.
integer
default:"1"
Page number (1-based).
integer
default:"50"
Records per page.

Response

200 OKPagedListResult<AlertDto>
AlertType is an integer discriminator. Use GET /v2/api/companies/{id}/alerts to retrieve alert configurations, which include the string AlertType label for each alert definition.

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 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