Listings
Retrieves business listings matching the specified criteria.
post/v1/listings/business/_search
Request body
pageNumberinteger
advertiserIdinteger
AdvertiserId e.g. An Agency ID
propertyTypesstring[]
Listing property types
keywordsstring[]
Search listings by keyword
brandIdinteger
The franchise brand ID
franchiseGroupIdinteger
The franchise group ID. A franchise group owns multiple franchise brands.
pageSizeinteger
Search results page size
sort'default' | 'newestFirst' | 'lowTotalPriceFirst' | 'hightTotalPriceFirst' | 'suburbAsc' | 'suburbDesc'
Sorting order
searchMode'forSale' | 'franchiseOpportunity' | 'franchiseBrand'
Search mode
Response
OK
pricestring
Formatted listing price
propertyAreastring
Building size
propertyTypestring
Property type
addressstring
Full address
headlinestring
Headline
hasVideoboolean
Has video?
auctionDatestring
Auction date
idinteger
AdID
carspaceCountinteger
Car parking spaces count