List vehicles - HQ Rental Software

Returns the vehicles of the fleet that the API user can see. When the account restricts users by branch or location, non-admin users only get the vehicles of their branches and locations.

By default the list leaves out vehicles that are sold or on sale, stolen, recovered, totaled or repossessed, and vehicles whose class or branch is inactive. Pass show_inactive=1 to include them.

For synchronization, load the full list once and then call this endpoint with show_inactive=1 and updated_since set to the time of your previous run, every few minutes or hourly, and read available and status. A change can take a few seconds to appear in this list. Also reload the full list periodically, for example daily: activating or deactivating a class or branch changes available without changing the vehicles' updated_at, which updated_since filters on.

Without paginate, every matching vehicle is returned in one response. For large fleets pass paginate=1 with limit and page. The paginated response is the current page as a plain array in data, without page metadata. Its items leave out vehicle_class_label, fuel_level_for_display, damages_page and current_vehicle_information, and return raw column values (booleans as 0/1, custom fields unformatted, dates as YYYY-MM-DD HH:mm:ss UTC). Keep requesting the next page until a page has fewer than limit items.

Responses

🟢200OK

application/json

The matching vehicles in data. data is an empty array when nothing matches. HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": [
        {
            "id": 57,
            "label": "Toyota Corolla - KLM 4821",
            "vehicle_key": "U-104",
            "vehicle_model_id": 812,
            "vehicle_class_id": 4,
            "vehicle_type_id": 1,
            "year": 2025,
            "color": "White",
            "vin": "2T1BURHE5KC123456",
            "plate": "KLM 4821",
            "odometer": 18240,
            "status": "available",
            "fuel_level": 8,
            "current_location_id": 1,
            "tour_operator_id": null,
            "fuel_type_id": null,
            "tank_size": 50,
            "latitude": null,
            "longitude": null,
            "hardware_provider": null,
            "hardware_id": null,
            "uuid": "5f0c1d2e-8a3b-4c7d-9e1f-2a3b4c5d6e7f",
            "created_at": "2025-11-03T14:20:00.000000Z",
            "updated_at": "2026-10-07T18:45:12.000000Z",
            "available": true,
            "vehicle_classes": [],
            "vehicle_class_label": "Economy",
            "fuel_level_for_display": "8 / 8",
            "status_color": "#50cc99",
            "status_label": "Available",
            "settings": {
                "hide_fuel_level_odometer_tracking": false,
                "fuel_level_tracking": true,
                "odometer_tracking": true,
                "relocations_amount_field_must_be_shown": false
            },
            "can_be_relocated": true,
            "damages_page": "https://yourcompany.example.com/public/fleets/vehicles/5f0c1d2e-8a3b-4c7d-9e1f-2a3b4c5d6e7f/damages-page",
            "vehicle_model": {
                "id": 812,
                "vehicle_brand_id": 41,
                "name": "Corolla",
                "vehicle_brand": {
                    "id": 41,
                    "name": "Toyota"
                }
            },
            "vehicle_class": {
                "id": 4,
                "brand_id": 1,
                "name": "Economy",
                "active": true,
                "images": []
            },
            "vehicle_type": {
                "id": 1,
                "label": "Car",
                "active": true
            },
            "current_location": {
                "id": 1,
                "name": "Miami Airport",
                "brand_id": 1
            },
            "current_vehicle_information": null
        }
    ]
}

🟠400Bad Request