Request & response format

Content types

Usage	Content-Type
Token endpoint	`application/x-www-form-urlencoded` or `multipart/form-data`
`POST /v2/api/vehicles/list`	`application/json` (body `{ "vehicleIds": [ ... ] }`)
Webhooks: `POST /v2/api/webhooks`, `PUT /v2/api/webhooks/{id}`, `POST /v2/api/webhooks/{id}/link-alert`	`application/json`
Other `GET`, `PUT` and `DELETE` routes	No body; parameters in path or query string
Successful JSON responses	`application/json; charset=utf-8`

Token route in the API Reference: API key token.

Response envelope

Successful operations return the payload directly (200 OK with DTO JSON). There is no global wrapper like { "data": ... }. Service-layer results use ApiResult / ApiResult<T> internally; controllers map them to HTTP status codes and return either the DTO or the error object as the JSON body (see Errors).

Response headers

Header	Type	Description
`X-API-Version`	string	Always `2`. Sent on every `/v2/api` response except a `401` for a missing, invalid or expired bearer token, and a `429`.

Rate limiting

Limits apply per API key and per endpoint, in four fixed windows: per second, per minute, per hour and per day. A request must be within all four. A request over any limit is rejected with 429, not queued. Every V2 endpoint is rate-limited except the token endpoint, POST /v2/api/authentication/token/api-key. Every response that reaches the endpoint counts against the limit, including 403, 404, 409, 422 and 500; follow-up pages in a pagination session do not. Responses from a rate-limited endpoint carry these headers once the token has authenticated:

Header	Type	Description
`X-RateLimit-Limit`	integer	The limit of the most constrained window for your API key on this endpoint
`X-RateLimit-Remaining`	integer	Requests remaining in that window
`X-RateLimit-Reset`	integer	Approximate Unix timestamp when that window resets. Do not use it to time a retry; use `Retry-After`
`X-RateLimit-Policy`	string	The window the two values above refer to: `second`, `minute`, `hour` or `day`

They are absent on a 401 for a missing, invalid or expired bearer token, on a 404 with code: PATH_NOT_FOUND, on a 405, on the token endpoint, and on follow-up pages served free by a pagination session. When a limit is exceeded, the server returns 429 Too Many Requests with an additional header:

Header	Type	Description
`Retry-After`	integer	The length in seconds of the window that was exhausted: `1`, `60`, `3600` or `86400`

Retry strategy: wait the full Retry-After value before retrying. That always clears the window that was exhausted; if another window is also used up, the retry gets a new 429 with that window’s Retry-After, so wait again. Limits:

Endpoint	Per second	Per minute	Per hour	Per day
Vehicles
`GET /v2/api/vehicles/{imei}/device-ids`	10	60	6,000	144,000
`GET /v2/api/vehicles/{id}/last-position`	144,000	144,000	144,000	60
`GET /v2/api/vehicles/{id}/positions`	144,000	144,000	60	144,000
`PUT /v2/api/vehicles/{id}/odometer`	10	30	6,000	144,000
`PUT /v2/api/vehicles/{id}/odometer/source`	10	30	6,000	144,000
`PUT /v2/api/vehicles/{id}/name`	10	30	6,000	144,000
`GET /v2/api/vehicles/{id}/last-online`	2	144,000	144,000	144,000
`POST /v2/api/vehicles/list` ³	10	30	6,000	144,000
`GET /v2/api/vehicles/{id}/engine-codes`	10	30	6,000	144,000
`GET /v2/api/vehicles/info`	144,000	60	144,000	144,000
`GET /v2/api/vehicles/{id}/odometer`	10	30	6,000	144,000
Companies (fleet-wide)
`GET /v2/api/companies`	4	30	600	14,400
`GET /v2/api/companies/{id}/vehicles/last-time-online`	4	20	600	14,400
`GET /v2/api/companies/{id}/vehicles/nearest` ²	4	20	600	14,400
`GET /v2/api/companies/{id}/vehicles/last-position` ¹ ²	4	20	600	14,400
`GET /v2/api/companies/{id}/alert-records`	4	20	600	14,400
`PUT /v2/api/companies/{id}/set-all-alerts-read`	4	20	600	14,400
`GET /v2/api/companies/{id}/alerts`	4	20	600	14,400
Alerts
`PUT /v2/api/alerts/{id}/{date}/update-read-status`	10	60	6,000	144,000
Replay
`GET /v2/api/replay/{id}`	4	20	600	14,400
Battery health
`GET /v2/api/battery-health`	4	30	600	14,400
Webhooks
`POST /v2/api/webhooks`	4	20	600	14,400
`GET /v2/api/webhooks/{id}`	10	60	6,000	144,000
`GET /v2/api/webhooks`	4	20	600	14,400
`PUT /v2/api/webhooks/{id}`	4	20	600	14,400
`DELETE /v2/api/webhooks/{id}`	4	20	600	14,400
`POST /v2/api/webhooks/{id}/link-alert`	4	20	600	14,400
Authentication
`POST /v2/api/authentication/token/api-key`	not rate-limited

Four single-vehicle endpoints have a single tight window that is the limit in practice: GET /v2/api/vehicles/info allows 60 per minute; GET /v2/api/vehicles/{id}/last-online allows 2 per second; GET /v2/api/vehicles/{id}/last-position allows 60 per day; GET /v2/api/vehicles/{id}/positions allows 60 per hour. The count is per API key across all vehicles, not per vehicle. ¹ This endpoint returns the last known position for every vehicle mapped to the company. Recommended usage is approximately one poll cycle every 5 minutes. A cycle costs at least one counted request per company — follow-up pages are free in a pagination session — so spread the requests: if the calls are sent together, the per-second (4) and per-minute (20) limits are the first ones hit. Polling more frequently than this is unlikely to yield new data and burns through the budget quickly. ² Nearest vehicles loads every vehicle mapped to the company on each request; Fleet last positions loads one page at a time. The rate limit applies per request regardless of fleet size. ³ Accepts a maximum of 50 vehicle IDs per request.

Pagination

Paginated V2 endpoints accept page (1-based, default 1) and pageSize (default 50) query parameters and return:

{
  "items": [...],
  "currentPage": 1,
  "numberOfPages": 7,
  "totalResults": 342,
  "lastResultIndex": 50
}

Field	Type	Description
`items`	array	Records on the current page
`currentPage`	integer	Current page number (1-based)
`numberOfPages`	integer	Total number of pages
`totalResults`	integer	Total records across all pages
`lastResultIndex`	integer	Position (1-based) of the last record on this page in the whole result: `(currentPage − 1) × pageSize +` the number of items on this page

GET /v2/api/battery-health pages differently: it takes pageNumber (default 1) and pageSize (default 25), and returns page, pageSize and totalCount instead of currentPage, numberOfPages and totalResults. It has no lastResultIndex.

V2 pagination parameters:

Parameter	Default	Max	Description
`page`	`1`	—	Page to retrieve (1-based)
`pageSize`	`50`	`500` (`100` on alert records and alert configurations)	Records per page

Legacy V1 pagination parameters (applies only to POST /api/GetCompanyVehiclesBatteryHealth):

Parameter	Default	Max	Description
`pageNumber`	`1`	—	Page to retrieve (1-based)
`resultsPerPage`	`25`	`500`	Records per page
`searchString`	—	—	Optional filter (name or IMEI)

Endpoints with pagination support:

Endpoint	Parameters
`POST /api/GetCompanyVehiclesBatteryHealth` (V1 legacy)	`pageNumber` / `resultsPerPage`
`GET /v2/api/companies`	`page` / `pageSize`
`GET /v2/api/companies/{id}/vehicles/last-time-online`	`page` / `pageSize`
`GET /v2/api/companies/{id}/vehicles/nearest`	`page` / `pageSize`
`GET /v2/api/companies/{id}/vehicles/last-position`	`page` / `pageSize`
`GET /v2/api/companies/{id}/alert-records`	`page` / `pageSize`
`GET /v2/api/companies/{id}/alerts`	`page` / `pageSize`
`GET /v2/api/replay/{id}`	`page` / `pageSize`
`GET /v2/api/vehicles/{id}/positions`	`page` / `pageSize`
`POST /v2/api/vehicles/list`	`page` / `pageSize`
`GET /v2/api/vehicles/{id}/engine-codes`	`page` / `pageSize`
`GET /v2/api/webhooks`	`page` / `pageSize`
`GET /v2/api/battery-health`	`pageNumber` / `pageSize` — returns `totalCount` instead of `totalResults`

Pagination sessions

Follow-up pages of the V2 endpoints listed above, except battery health, can be fetched without counting against the rate limit:

Request a page with an explicit page parameter. This first request counts as usual. A 200 response carries an X-Session-Token header.
Request further pages of the same endpoint and query (page and pageSize may change) and send the latest token back in an X-Session-Token request header. Each page you have not fetched yet in this session is free and has no X-RateLimit-* headers.

Always send the token from the most recent response.
Fetching a page again counts against the limit and starts a new session.
A token works only with the API key that created it, and expires after 10 minutes without use.
Changing any other query parameter starts a new session.
GET /v2/api/battery-health does not take part (it pages with pageNumber).

Date and time

JSON serialization for DateTime uses custom converters (SimplifiedDateTimeConverter) that write without fractional seconds, e.g. 2026-04-07T14:32:00.
Request parameters: pass ISO-like strings that DateTime.Parse accepts (e.g. 2026-04-07T14:32:00 or 2026-04-07T14:32:00Z depending on client). Many actions call DateTime.SpecifyKind(..., Utc) in code—treat replay and position ranges as UTC unless the controller comment says otherwise.
TimeSpan values in JSON (e.g. trip duration) use the .NET format [d.]hh:mm:ss[.fffffff], not ISO 8601.

Null vs omitted

Fields are always present. A field with no value is written as null, not omitted.
For PositionDto, isOnline is always present. Single-vehicle Last position never sets it, so it is always false there.

Getting Started

Guides

Authentication

Companies & fleet

Vehicles

Vehicle commands

Alerts

Telemetry & replay

Insights & diagnostics

Webhooks

Reference

Request & response format

Content types

Response envelope

Response headers

Rate limiting

Date and time

Null vs omitted

​Content types

​Response envelope

​Response headers

​Rate limiting

​Pagination

​Pagination sessions

​Date and time

​Null vs omitted

Content types

Response envelope

Response headers

Rate limiting

Pagination

Pagination sessions

Date and time

Null vs omitted