Skip to main content

List public car rental vehicles (v1)

Method & Path

GET /api/v1/public/:workspaceSlug/carrental/vehicles

Actual path: /v1/public/:workspaceSlug/carrental/vehicles

Description

List vehicles for a car rental workspace. Workspace is resolved by workspaceSlug (must match publicSlug in carrental-settings).

Authentication

None – Public endpoint.

Path parameters

ParameterTypeRequiredDescription
workspaceSlugstringYesPublic slug from carrental-settings (e.g. demo-rentals).

Query parameters

ParameterTypeRequiredDescription
statusstringNoFilter: AVAILABLE, RESERVED, RENTED, MAINTENANCE.
branchIdstringNoFilter by branch ID.
categoryIdstringNoFilter by vehicle category ID.
pagenumberNoPage (1-based).
limitnumberNoPage size.

Response 200 OK

{
"items": [
{
"id": "...",
"brand": "Toyota",
"model": "Corolla",
"year": 2023,
"plateNumber": "ABC-123",
"color": "White",
"transmission": "AUTO",
"fuelType": "GAS",
"seats": 5,
"dailyPrice": 150,
"status": "AVAILABLE",
"specs": {},
"photos": [{ "url": "https://...", "createdAt": "..." }]
}
],
"total": 10,
"page": 1,
"limit": 20
}

Common errors

  • 404: Car rental not found for this slug.
  • 500: Server error.