Skip to main content
GET
List Vehicle

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

customerId
string
required

Query Parameters

pageIndex
integer<int32>

Specifies the pagination page index.
Pages are zero indexed, i.e. the first page has an index value of zero.

pageSize
integer<int32>

Specifies the number of items to include on a page.
Must be specified if pageIndex has been specified.

vehicleIds
string[]

Comma separated list of vehicle identifiers (alphanumeric).

groupIds
string[]

Comma separated list of group identifiers (alphanumeric).

registration
string

Vehicle registration number

name
string

Friendly name of a vehicle

activeOnly
boolean

Filter to return only active vehicles

Response

Vehicles were successfully returned.

totalPages
integer<int32>

Total number of pages based on the pageSize.

totalCount
integer<int64>

Total number of items that matched the search parameters.

items
object[]

Array of items.