List Vehicles
Retrieve a paginated list of vehicles in the fleet with real-time telemetry data from the INVERS telematics system. This endpoint provides fleet managers with a comprehensive view of all vehicles under their management.
The vehicle list is the primary interface for fleet monitoring, showing:
- Vehicle Details: Plate number, make, model, year, and category
- Status: Current availability (available, booked, in use, maintenance)
- Real-time Telemetry: Fuel level, mileage, lock state, and last update time
- Pricing: Hourly and daily rates
- Assignment: Which agency the vehicle belongs to
Use powerful filters to quickly find specific vehicles:
- Filter by agency to see a single branch's fleet
- Filter by status to find available vehicles or those in maintenance
- Search by plate number when looking for a specific vehicle
- Filter by category (sedan, SUV, van) for fleet composition analysis
Permission Required
This endpoint requires the vehicles.view permission.
Endpoint
INFO
GET /api/v1/dashboard/vehicles
Headers
| Header | Value | Required |
|---|---|---|
Accept | application/json | Yes |
Authorization | Bearer {token} | Yes |
Query Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
agency_id | integer | - | Filter by agency |
status | string | - | Filter: available, booked, in_use, maintenance |
category | string | - | Filter: sedan, suv, van, etc. |
search | string | - | Search by plate number, brand, model |
page | integer | 1 | Page number |
per_page | integer | 15 | Items per page |
Example Request
bash
curl -X GET "https://api.daakey.com/api/v1/dashboard/vehicles?agency_id=1&status=available" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"Response
Success (200)
json
{
"success": true,
"message": "Vehicles retrieved",
"data": [
{
"id": 1,
"plate_number": "ABC-123",
"brand": "Toyota",
"model": "Corolla",
"year": 2023,
"color": "White",
"category": "sedan",
"status": "available",
"agency": {
"id": 1,
"name": "Downtown Branch"
},
"telemetry": {
"fuel_level": 85,
"mileage": 15420,
"is_locked": true,
"last_update": "2024-01-15T10:00:00Z"
},
"pricing": {
"hourly_rate": 15.00,
"daily_rate": 80.00
},
"created_at": "2024-01-01T00:00:00Z"
},
{
"id": 2,
"plate_number": "XYZ-789",
"brand": "Honda",
"model": "CR-V",
"year": 2022,
"color": "Black",
"category": "suv",
"status": "booked",
"agency": {
"id": 1,
"name": "Downtown Branch"
},
"telemetry": {
"fuel_level": 60,
"mileage": 28500,
"is_locked": true,
"last_update": "2024-01-15T09:30:00Z"
},
"pricing": {
"hourly_rate": 20.00,
"daily_rate": 110.00
},
"created_at": "2024-01-05T00:00:00Z"
}
],
"meta": {
"current_page": 1,
"last_page": 5,
"per_page": 15,
"total": 72
},
"request_id": "uuid",
"timestamp": "2024-01-01T00:00:00.000Z"
}Vehicle Status Values
| Status | Description |
|---|---|
available | Ready for booking |
booked | Reserved, not yet picked up |
in_use | Currently being used |
maintenance | Under maintenance |
unavailable | Not available for booking |