Retrieves vehicles.

SecurityAPIKey
Request
query Parameters
groupId
string or null^[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}...

ID of the group that the vehicle of interest is associated to (GUID).

name
string or null [ 1 .. 50 ] characters

An identifier to filter by a vehicle's name. This parameter allows for matching all or any part of a vehicle name. If more than one vehicle matches the name pattern, a list of them will be returned. Pattern is considered as match either partially or fully (i.e. pattern=“ABC”, matches: ABC, myABCvehicle, ABCfleet, fleetABC etc.)

limit
integer <int32> [ 1 .. 1000 ]
Default: 100

Number of vehicles to receive.

page
integer <int32> [ 1 .. 2147483647 ]
Default: 1

Number of the page from which vehicles should be receive.

includeSubgroups
boolean
Default: true

Indicates whether results should include data for all subgroups of the group specified.

Responses
200

Vehicles retrieved.

204

No vehicles were found that match the specified selection criteria.

400

The parameters given in the request are invalid.

401

Unauthorized due to providing an invalid access key, or invalid pod.

403

You have no permissions to make this operation.

500

Requested operation cannot be performed.

503

Requested operation cannot be performed. Try again later.

get/all
Request samples 
Response samples 
application/json
{
  • "vehicles": [
    ],
  • "totalResults": 0
}
© 2023 Lytx, Inc. All rights reserved