List locations - HQ Rental Software

Returns the active pick-up and return locations of the account, ordered by their position in Settings and then by name. Use the location IDs as the pick-up and return locations of reservations. Inactive locations are never returned.

Locations change rarely: sync them once a day, or when your integration starts, and cache the result. The list is not paginated.

When the account has no active locations, the response body is an empty JSON array ([]) instead of an object.

Responses

🟢200OK

application/json

The active locations under the fleets_locations key, or [] when there are none. 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_locations": [
        {
            "id": 1,
            "name": "Miami Airport",
            "brand_id": 1,
            "is_airport": true,
            "coordinates": null,
            "active": true,
            "cc_email": "miami@example.com",
            "phone_number": "+1 305 555 0142",
            "order": 1,
            "open_hours": [
                {
                    "start_date": "2026-01-01",
                    "end_date": "2026-12-31",
                    "day_0": {
                        "opened": "0",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    },
                    "day_1": {
                        "opened": "1",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    },
                    "day_2": {
                        "opened": "2",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    },
                    "day_3": {
                        "opened": "3",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    },
                    "day_4": {
                        "opened": "4",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    },
                    "day_5": {
                        "opened": "5",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    },
                    "day_6": {
                        "opened": "6",
                        "start_time": "8:00",
                        "end_time": "20:00"
                    }
                }
            ],
            "label_for_website": {
                "en": "Miami Airport",
                "es": "Aeropuerto de Miami"
            },
            "timezone": "America/New_York",
            "country": "US",
            "state": "FL",
            "city": "Miami",
            "zip": "33142",
            "street": "4200 NW 21st St",
            "latitude": "25.795900000000",
            "longitude": "-80.287000000000",
            "external_reference_id": "MIA",
            "show_on_website": true,
            "all_map_coordinates": [],
            "pick_up_allowed": true,
            "return_allowed": true,
            "label_for_website_translated": "Miami Airport",
            "address": "4200 NW 21st St, Miami, FL, 33142, United States",
            "brand": {
                "id": 1,
                "name": "Miami",
                "currency": "USD",
                "vehicle_classes": [
                    {
                        "id": 4,
                        "brand_id": 1,
                        "name": "Economy",
                        "active": true
                    }
                ]
            }
        }
    ]
}

🟠400Bad Request