Skip to main content
GET
List Vehicles

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

filter
string

Generic filter that matches against

  • licensePlate
  • model
  • manufacturer
Example:

"ABC1D23"

status
string

Parses a comma-separated string.

Examples:

  • ACTIVE,INACTIVE
Example:

"ACTIVE,INACTIVE"

seatTypeName
string

Seat type name

Example:

"Executivo"

types
string

Parses a comma-separated string.

Examples:

  • VAN
Example:

"VAN"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
licensePlate,
model,
year,
createdAt
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List vehicles

data
object[]
required
meta
object
required