Skip to main content
GET
Nearest vehicles (V2)

Overview

Returns vehicles within the specified company sorted by distance from a given coordinate, optionally capped at a radius (metres) or a maximum result count.
The V1 version of this endpoint is Nearest vehicles. V2 is paginated.
Rate limit: 4 req/s · 20/min · 600/hr · 14,400/day

Endpoint

GET /v2/api/companies/{id}/vehicles/nearest

Path parameters

integer
required
Company ID.

Query parameters

number
Latitude of the reference point.
number
Longitude of the reference point.
integer
Maximum number of vehicles to return (applied after radius filter). Defaults to 5000 if omitted.
integer
Maximum distance in metres. Vehicles beyond this radius are excluded.
integer
default:"1"
Page number (1-based).
integer
default:"50"
Records per page.

Response

200 OKPagedListResult<NearestPointResultItemDto> Each item in the paginated items array:

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

lat
number
lng
number
num
integer
radius
integer

Maximum distance in metres.

page
integer
default:1
pageSize
integer
default:50

Response

Successful response