Search a site for units open on given dates
list_propertiesLists the units on one Booking Bench site that can be booked for a stay: open every night and within the unit's minimum stay, maximum stay, arrival and departure rules and guest capacity. checkIn and checkOut are required. guests defaults to 2, and the answer says when the default was used. Optional filters: city (a town on that site), minBedrooms, minBathrooms, amenities (all must be listed), petsAllowed. sort is fit (smallest unit that sleeps the party, then bedrooms, then name; the default), price, or name. No result is ranked by payment. Each result has propertyId, name, city, state, sleeps, bedrooms, bathrooms and averageNightlyRate (per night over the stay, before cleaning fee and taxes). The answer gives returned, totalMatches (or totalMatchesAtLeast when not every unit was checked), nextCursor, refinements (unused filters with how many units would remain) and notes. More than 10 matches return the best 5. Availability is up to 5 minutes old; get_quote is live.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| city | No | Only units in this town on the site, for example the matchedCity from list_sites. | |
| sort | No | Result order. Default fit. | |
| limit | No | How many results to return, 1 to 10. | |
| cursor | No | The nextCursor from an earlier answer to the same search, unchanged. | |
| guests | No | Number of guests. Default 2. | |
| checkIn | Yes | Arrival date as YYYY-MM-DD. | |
| checkOut | Yes | Departure date as YYYY-MM-DD. | |
| siteSlug | Yes | The siteSlug of a Booking Bench site, as returned by list_sites. | |
| amenities | No | Amenity names the unit must list, for example "Hot tub". Matched ignoring case. | |
| minBedrooms | No | Minimum number of bedrooms. | |
| petsAllowed | No | True returns only units that allow pets. | |
| minBathrooms | No | Minimum number of bathrooms. |