Skip to main content
GET
List vehicles
Each vehicle comes with its dedicated wallet — its balance and the users who can use it. A vehicle whose wallet can’t be read at that moment is returned without one; send includeWallet=false to leave the wallets out altogether, which is faster. Filter by name and licensePlate (both match part of the text, ignoring case), status or walletId, and page with limit + next. status takes its values comma-separated (?status=ACTIVE,ARCHIVED); repeating the parameter (?status=ACTIVE&status=ARCHIVED) works too. A blank parameter counts as not sent.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose vehicles you want to list.

Format: UUID

Query Parameters

name
string

Only vehicles whose name contains this text (case-insensitive).

Maximum string length: 256
licensePlate
string

Only vehicles whose license plate contains this text. Case, hyphens and spaces are ignored.

Maximum string length: 16
status
enum<string>[]

Only vehicles in these statuses. Omit to list both.


Example (comma-separated list): ?status=ACTIVE,ARCHIVED

Available options:
ACTIVE,
ARCHIVED
walletId
string

Only the vehicle whose dedicated wallet has this ID (its external.walletId).

Required string length: 1 - 64
includeWallet
enum<string>
default:true

false returns the vehicles without their wallet, which is faster.

Available options:
true,
false
next
string

Cursor returned as next by the previous page. Omit for the first page.

limit
integer
default:15

Page size.

Required range: 1 <= x <= 100
order
enum<string>
default:DESC

Sort direction of orderBy. Case-insensitive.

Available options:
ASC,
DESC
orderBy
enum<string>
default:createdAt

Field to sort by. Only createdAt is supported.

Available options:
createdAt

Response

Successful response

A page of vehicles.

items
object[]
required

Vehicles, newest first unless order=ASC.

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"MjAyNi0xMC0xN1QxMzo0NToxMi4wMDBa"