Skip to main content
POST
Search Listings

Headers

Authorization
string
required

Bearer [access_token]

Content-Type
string
required

application/json

Body

application/json
searchScope
enum<string>
default:all

Search scope. 'my' = agent's own listings, 'office' = office-level listings, 'all' = all listings the agent has access to. Default 'all'.

Available options:
my,
office,
all
soldFlag
boolean

Whether to search sold listings. Default false (active listings).

filterConditions
object

Advanced search filter conditions. Keys must match condition names in the property.condition table. Examples:

  • "location": {"city": ["Seattle"]} (suggestion type)
  • "price": "100000,500000" (inputBox range: "min,max")
  • "beds": "2," (inputBox range: min only)
  • "baths": ",3" (inputBox range: max only)
  • "sqFt": "1000,3000" (inputBox range)
  • "daysOnSite": ",30" (inputBox days: within last N days)
  • "propertyType": ["Condo", "Townhouse"] (multiSelect labels)
  • "purchaseType": ["For Sale"] (singleSelect label)
sortFields
string[]

Sort fields. Values from ListingSortEnum, e.g. MLS_LIST_DATE_L_DESC, PRICE_DESC, PRICE_ASC, BEDROOMS_DESC, BATHS_DESC, BUILT_YEAR_DESC, SQFT_DESC, RELEVANCE, QUALITY_DESC, OPEN_HOUSE_DESC.

returnFields
string[]

Return fields. If empty, uses default fields for the listing type.

pageNum
integer<int32>
default:1

Page number, starting from 1. Default 1.

pageSize
integer<int32>
default:25

Page size, 1–100. Default 25.

Response

200 - application/json

successful operation

Search response for ListingV2

listing
object[]
metadata
object