Skip to main content
search_listings searches apartment listings through brightplace using objective renter criteria.

When to use it

Use search_listings when a renter asks for apartments matching objective criteria such as price, location, bedrooms, bathrooms, amenities, or move-in timing. Do not use it for protected-class or demographic steering requests. Those requests return FAIR_HOUSING_VIOLATION.

Input

Filter-only searches are allowed. When query is omitted, brightplace ranks results from the objective filters provided by the renter.

Searching by manager or building name

Each entry in filters.names is matched case-insensitively as a substring of both the property manager’s name and the building’s name, so you can pass a renter’s phrasing without deciding which one they meant: ["greystar"] reaches Greystar Real Estate Partners, and ["roosevelt collection"] reaches Roosevelt Collection Lofts. Pass only the distinctive part of the name, not "greystar apartments". Multiple entries widen the search to any of them, and the filter combines with location and price as an AND. An empty result means brightplace holds no inventory under that name.

Output

The tool returns ListingSummary[].
listing_id is the listing snapshot id to pass into get_listing, get_tour_availability, and book_tour.