Sign in
OpenAPI 3.0.42026-08-111134241.0 MB

839de6c29cc3

AgentSearch

Retrieves agents matching the specified location criteria.

post/v2/agentsearch/agents/location

Request body

sortBy'default' | 'nameAscending' | 'nameDescending' | 'totalSoldAscending' | 'totalSoldAndAuctionedAscending' | 'totalSoldAndAuctionedDescending' | 'totalSoldDescending' | 'avgSalePriceAscending' | 'avgSalePriceDescending' | 'avgDayOnMarketAscending' | 'avgDayOnMarketDescending' | 'forSaleAscending' | 'forSaleDescending' | 'forRentAscending' | 'forRentDescending' | 'totalLeasedDescending' nullable

Gets or Sets SortBy

agentType'all' | 'sale' | 'rent' | 'soldOnly' nullable

Gets or Sets AgentType

suburbsstring[] nullable

Gets or Sets Suburbs

suburbIdsinteger[] nullable

Gets or Sets SuburbIds

pageinteger nullable

Gets or Sets Page

pageSizeinteger nullable

Gets or Sets PageSize

agentNameKeywordstring nullable

Gets or Sets AgentNameKeyword

propertyTypestring nullable

Gets or Sets PropertyType

bedroomsnumber double nullable

Gets or Sets Bedrooms

Response

OK

totalinteger nullable

Gets or Sets Total

totalPagesinteger nullable

Gets or Sets TotalPages

pageNumberinteger nullable

Gets or Sets PageNumber