Get all vehicle types

GET 
/v1/vehicle-types

Retrieves a list of all vehicle types with their configuration, icons, and capacity settings

Request

Query Parameters

page number

Possible values: >= 1

Default value: 1

Page number for pagination

limit number

Possible values: >= 1

Default value: 10

Number of items per page

name string

Filter by vehicle type name (case-insensitive)

Responses

200

List of vehicle types retrieved successfully

application/json

Schema

Schema

data object[]required
The data of the paginated response
Array [
_id stringrequired
The ID of the vehicle type
name stringrequired
The name of the vehicle type
iconOnMap stringrequired
The icon on map of the vehicle type
iconOnApp stringrequired
The icon on app of the vehicle type
iconOnWeb stringrequired
The icon on web of the vehicle type
passengers numberrequired
The passengers of the vehicle type
luggage numberrequired
The luggage of the vehicle type
description stringrequired
The description of the vehicle type
createdDate date-timerequired
The created date of the vehicle type
latestUpdate date-timerequired
The latest update date of the vehicle type
]
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",
      "name": "Vehicle Type 1",
      "iconOnMap": "https://example.com/icon.png",
      "iconOnApp": "https://example.com/icon.png",
      "iconOnWeb": "https://example.com/icon.png",
      "passengers": 1,
      "luggage": 1,
      "description": "Description of the vehicle type",
      "createdDate": "2025-01-01T00:00:00.000Z",
      "latestUpdate": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}

Loading...