Get all vehicles

GET 
/v1/vehicles

Retrieves a paginated list of vehicles. Supports filtering by plate number, vehicle type, and supplier.

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number (default: 1)

limit number

Possible values: >= 1

Default value: 10

Items per page (default: 10)

plateNumber string

Filter by plate number (case-insensitive)

vehicleTypeId string

Filter by vehicle type ID

supplierId string

Filter by supplier ID

Responses

200

List of vehicles retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the vehicle
plateNumber stringrequired
The plate number of the vehicle
vehicleTypeId stringrequired
The vehicle type ID of the vehicle
vehicleTypeName stringrequired
The vehicle type name of the vehicle
supplierId stringrequired
The supplier ID of the vehicle
make string
The make of the vehicle. Require if the model is provided.
model string
The model of the vehicle
year number
The year of the vehicle
color string
The color of the vehicle
passengers number
The passengers of the vehicle
luggage number
The luggage of the vehicle
createdDate date-time
The created date of the vehicle
latestUpdate date-time
The latest update date of the vehicle
]
total numberrequired

The total number of items

page numberrequired

The current page

limit numberrequired

The number of items per page

totalPages numberrequired

The total number of pages

Example (from schema)

{
  "data": [
    {
      "_id": "672d07188234567890123456",
      "plateNumber": "ABC-123",
      "vehicleTypeId": "507f1f77bcf86cd799439013",
      "vehicleTypeName": "Car",
      "supplierId": "507f1f77bcf86cd799439013",
      "make": "Toyota",
      "model": "Camry",
      "year": 2023,
      "color": "Black",
      "passengers": 1,
      "luggage": 1,
      "createdDate": "2025-01-01T00:00:00.000Z",
      "latestUpdate": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Loading...