List all vehicles.
GET/api/vehicles
Retrieve the list of vehicles for users created by a partner.
Request
Query Parameters
Default value: 0
Page number
Default value: 10
Number of items per page
Possible values: [license
, vin
, state
, dateAdded
, active
]
Default value: dateAdded
Sort by field
Possible values: [asc
, desc
]
Default value: desc
Sort by order
Possible values: [license
, vin
, state
, userFirstName
, userLastName
, userEmail
, userPhone
]
Search by field
Search by value
Filter vehicles by active flag
Filter vehicles whose addition date is greater or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)
Filter vehicles whose addition is less or than equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)
Header Parameters
Partner Id
Client Id
Client Secret
Responses
- 200
- 401
- 500
List of vehicles matching the query.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
Total number of vehicles
Current page number
Current page size
Number of vehicles on current page
vehicles
object[]
List of vehicles
Id of the vehicle
License plate number
Photo of Vehicle
Make of the vehicle
Model of the vehicle
VIN of the vehicle.
2 Letter State Code (eg. AL, CA, CO etc.)
Year vehicle was built.
Time at which vehicle was added to the system
Last updated timestamp
owner
object
Check-in owner
Id of the user
User's first name
User's last name
{
"totalItems": 0,
"currentPage": 0,
"totalPages": 0,
"itemsOnPage": 0,
"vehicles": [
{
"id": "string",
"license": "string",
"photoUrl": "string",
"make": "string",
"model": "string",
"vin": "string",
"state": "string",
"year": "string",
"dateAdded": "string",
"updated": "string",
"owner": {
"id": "string",
"firstName": "string",
"lastName": "string"
},
"active": true
}
]
}
Authorization error e.g. due to an invalid or missing API keys.
Internal error. Possible error codes
-
INTERNAL_SERVER_ERROR
- application/json
- Schema
- Example (from schema)
Schema
Error code
A verbose error message
{
"error_code": "string",
"error_message": "string"
}