List branches

Returns every branch of the account, including inactive ones (inactive: true). Use the id as brand_id in other requests, for example to list the vehicle classes or locations of one branch.

Each branch also comes with the HTML snippets that embed the HQ booking website in your own site, the same ones shown in Settings > Branches. The list is not paginated.

Responses

🟢200OK

application/json

The branches under the fleets_brands key. A successful body has no success field. HTTP 200 is also used for failures: such a body has success: false and is an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "fleets_brands": [
        {
            "id": 1,
            "name": "Miami",
            "uuid": "3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69",
            "inactive": false,
            "currency": "usd",
            "supported_currencies": [
                "usd",
                "eur"
            ],
            "tax_label": "Sales Tax",
            "abb_tax": "7.0000000",
            "location_fee_label": "Location Fee",
            "location_fee": "0.0000000",
            "government_tax": "0.0000000",
            "prefix": "MIA-${id}",
            "email_address": "miami@example.com",
            "website_link": "https://www.example.com",
            "contact_information": "<p>Example Rentals<br />4200 NW 21st St, Miami</p>",
            "street": "4200 NW 21st St",
            "city": "Miami",
            "state": "FL",
            "zip": "33142",
            "country": "us",
            "pick_up_location_id": 1,
            "return_location_id": 1,
            "percentage_to_charge_online": "20.0000000",
            "fixed_amount_to_charge_online": "0.0000000",
            "public_reservations_link_first_step": "https://yourcompany.example.com/public/car-rental/reservations/step1?brand=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69&new=true",
            "public_reservations_link_full": "https://yourcompany.example.com/public/car-rental/reservations/recover-last-booking?brand_uuid=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69",
            "public_packages_link_first_step": "https://yourcompany.example.com/public/car-rental/packages/dates?brand_id=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69&new=true",
            "public_packages_link_full": "https://yourcompany.example.com/public/car-rental/packages/recover-last-booking?brand_uuid=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69",
            "public_reservations_packages_link_first_step": "https://yourcompany.example.com/public/car-rental/reservations/step1?brand=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69&has_package_reservation=1&new=true",
            "my_reservations_link": "https://yourcompany.example.com/public/car-rental/reservations/my-reservations/login?brand_id=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69",
            "my_package_reservations_link": "https://yourcompany.example.com/public/car-rental/packages/my-reservations/login?brand_id=3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69",
            "integration_snippets": {
                "reservation-form": "<script src=\"https://yourcompany.example.com/public/car-rental/integrations/assets/integrator\"></script><div class=\"hq-rental-software-integration\" data-integrator_link=\"https://yourcompany.example.com/public/car-rental/integrations\" data-brand=\"3f1c9e2a-7b4d-4c8e-9a6f-1d2e3c4b5a69\" data-snippet=\"reservation-form\"></div>"
            },
            "integration_snippets_framer": {
                "reservation-form": "import * as React from \"react\"\n..."
            }
        }
    ]
}

Request

Responses