Skip to main content
GET
/
api
/
vehicles
/
vehicleType
Get Vehicles by Type
curl --request GET \
  --url https://api.example.com/api/vehicles/vehicleType
{
  "vehicles": [
    {}
  ]
}

​
Request

​
q
string
required
The vehicle type to filter by (e.g., SUV, Sedan, Coupe, Hatchback)

​
Response

Returns an array of vehicles matching the specified type.
​
vehicles
Vehicle[]
Array of vehicle objects

​
Example

curl -X GET "http://localhost:8080/api/vehicles/vehicleType?q=SUV"

​
Response Example

[
  {
    "id": 1,
    "reference": "BMW2024A1B2",
    "brand": "BMW",
    "model": "X5",
    "year": 2024,
    "price": 150.00,
    "vehicleType": "SUV",
    "hp": 340,
    "doors": 5
  },
  {
    "id": 2,
    "reference": "AUD2024C3D4",
    "brand": "Audi",
    "model": "Q7",
    "year": 2024,
    "price": 145.00,
    "vehicleType": "SUV",
    "hp": 335,
    "doors": 5
  }
]

​
Common Vehicle Types

  • SUV
  • Sedan
  • Coupe
  • Hatchback
  • Convertible
  • Station Wagon
  • Van
  • Pickup Truck
Vehicle types are stored as strings in the database. Matching is case-sensitive.

Build docs developers (and LLMs) love

Get started for freeTalk to us