DOdomain
AgentSearch

Retrieves agents matching the specified location criteria.

Changed on
post/v2/agentsearch/agents/location

Request

Request body

suburbsstring[] nullable

Gets or Sets Suburbs

suburbIdsinteger[] nullable

Gets or Sets SuburbIds

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

Gets or Sets SortBy

pageinteger nullable

Gets or Sets Page

pageSizeinteger nullable

Gets or Sets PageSize

agentNameKeywordstring nullable

Gets or Sets AgentNameKeyword

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

Gets or Sets AgentType

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

Changes

  • ec196b46e439Revision changes
    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: text/json)

    • breaking

      the request property became not nullable (media type: application/*+json)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: text/json)

    • breaking

      the request property became not nullable (media type: application/*+json)

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 839de6c29cc3Revision changes
    • info

      endpoint added