List reservations (API v2) - HQ Rental Software

A lighter version of GET /car-rental/reservations: each reservation comes with its dates, status, totals as amounts with currency, and its drivers' contact details, instead of the full record.

Version 2 only. Send the header Accept: application/vnd.api.v2+json and call /car-rental/reservations without the trailing slash. Without that header you get the v1 list, which has a different format.

Order and visibility. Newest first (highest id first). Branch (brand_id) and location access restrictions of the API user apply, and tour operator users only get their own reservations.

Pagination. The page is in data: the reservations are in data.data, with data.next_page_url next to them. Stop when data.next_page_url is null.

Dates use the API user's time zone (see Dates, time zones and money) and the API user's date format, or your account's when the user has none, for example 09-10-2026 10:00. They are not ISO 8601.

Responses

🟢200OK

application/json

One page of reservations. 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": {
        "current_page": 1,
        "data": [
            {
                "id": 1052,
                "prefixed_id": "MIA1052",
                "pick_up_date": "09-10-2026 10:00",
                "return_date": "11-10-2026 10:00",
                "initial_pick_up_date": "09-10-2026 10:00",
                "initial_return_date": null,
                "flight_arrival_date": null,
                "flight_departure_date": null,
                "status": "open",
                "total_rack_rate": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "100.00",
                    "usd_amount": "100.00",
                    "amount_for_display": "$100.00"
                },
                "total_insurances": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "total_extras": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "total_taxes": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "7.00",
                    "usd_amount": "7.00",
                    "amount_for_display": "$7.00"
                },
                "total_revenue": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "100.00",
                    "usd_amount": "100.00",
                    "amount_for_display": "$100.00"
                },
                "total_price": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "107.00",
                    "usd_amount": "107.00",
                    "amount_for_display": "$107.00"
                },
                "total_paid": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "107.00",
                    "usd_amount": "107.00",
                    "amount_for_display": "$107.00"
                },
                "total_refunded": {
                    "currency": "usd",
                    "currency_icon": "$",
                    "amount": "0.00",
                    "usd_amount": "0.00",
                    "amount_for_display": "$0.00"
                },
                "vehicle_state": "FL",
                "primary_driver": {
                    "id": 529,
                    "reservation_id": 1052,
                    "contact_id": 112,
                    "contact": {
                        "id": 112,
                        "first_name": "Jane",
                        "last_name": "Doe",
                        "email": "jane.doe@example.com",
                        "phone_number": "+1 305 555 0142"
                    },
                    "primary_driver": true,
                    "additional_driver": false
                },
                "additional_drivers": []
            }
        ],
        "first_page_url": "https://api.hqrentals.app/api/car-rental/reservations?page=1",
        "from": 1,
        "last_page": 12,
        "last_page_url": "https://api.hqrentals.app/api/car-rental/reservations?page=12",
        "links": [],
        "next_page_url": "https://api.hqrentals.app/api/car-rental/reservations?page=2",
        "path": "https://api.hqrentals.app/api/car-rental/reservations",
        "per_page": 50,
        "prev_page_url": null,
        "to": 50,
        "total": 583
    }
}

🟠400Bad Request