Skip to main content
GET
Alert configurations (V2)

Overview

Returns alert definitions (configurations, not triggered events) for {id} and its direct sub-companies that are not cancelled. Unlike Alert records and Mark all alerts read, the scope here follows {id}. {id} must be your token’s company or one of its direct, non-cancelled sub-companies, otherwise the call returns 404. Pass a direct sub-company to get its sub-companies’ definitions; a deeper sub-company returns 404, even though List companies lists it. Deleted definitions and reminders are not returned. Paused definitions are returned too, and no field marks them as paused. Results are ordered by alertId. Each item has the alert type’s display name, the alert’s name and description, and the vehicles and tags saved on it. This is a new V2-only endpoint with no V1 equivalent.
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

GET /v2/api/companies/{id}/alerts

Path parameters

integer
required
Company ID.

Query parameters

integer
default:"1"
Page number (1-based).
integer
default:"50"
Records per page, 1–100.

Response

200 OK — PagedListResult<AlertConfigDto> units items:
units and tags are saved lists, not the monitored set. units lists the vehicles linked to the alert, and can include deleted vehicles. When isAllFleet is true the alert covers every vehicle of the company, whatever units lists; units then usually holds the vehicles selected when the alert was last saved, and can be out of date. tags is the tag list saved on the alert; when “All tags” is selected, the Dashboard saves the company’s tags as they were at that moment. On production, tags select vehicles only for Driving after dark alerts, and only when isAllTags is true: the alert then also covers vehicles carrying any tag in tags. Other alert types, and Driving after dark alerts with isAllTags false, select vehicles through isAllFleet and units only.

Example response

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

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

Response

Successful response