Returns all vehicles for the specified query terms.

SecurityAPIKey

Request

query Parameters

GroupId	string or null <guid> An identifier to filter by a group.
PageNumber	integer <int32> [ 1 .. 2147483647 ] The page number of the list of vehicles. Default value is 1.
PageSize	integer <int32> [ 1 .. 2147483647 ] The number of vehicles to return per page. Default value is 50.
VehicleName	string or null An identifier to filter by a vehicle's name.

Responses

200

400

The parameters given in the request are invalid.

401

Access is denied. This can occur from an invalid key or invalid pod.

get/vehicles

Request samples

curl
JavaScript
Node.js

Response samples

application/json

{"totalCount": 0,
"vehicles": [{"id": 0,
"groupId": "string",
"name": "string",
"status": 0,
"lastCommunication": "2019-08-24T14:15:22Z",
"devices": [{"id": 0,
"serialNumber": "string",
"lastCommunication": "2019-08-24T14:15:22Z",
"onlineStatus": 0,
"views": [{"id": 0,
"name": "string",
"label": "string"
}
],
"roleId": 0
}
]
}
]
}