v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Agencies

Retrieves summary of agencies matching the specified criteria.

The q parameter supports:

<ul> <li>name: search by name eg. ```name:"Agency XYZ"```</li> <li>providerId: search by providerId. eg. ```providerId:"ABC Software"```</li> <li>domainUrl: search by domainUrl. eg. ```domainUrl:"agency-xyz"```</li> <li>dateUpdated: search by dateUpdated. eg. ```dateUpdated:"2016-12-25"```</li> <li>suburbId: search by suburbId. Lists supported. eg. ```suburbId:1``` eg. ```suburbId:(1 OR 2 OR 3)```. Can include related suburbs by adding ```in:related```</li> <li>accountType: search by account type. Lists supported. eg. ```accountType:residential``` eg. ```accountType:(residential OR commercial)``` Valid values are: none, residential, commerciallight, commercialfull, developer, holiday, business</li> <li> ```in:all``` includes archived agencies (archived agencies excluded by default)</li> <li> ```-is:selfservice``` excludes selfservice</li> </ul>
get/v1/agencies

Query parameters

qstring

Search phrase. e.g. name:"Agency XYZ"

pageNumberinteger

Page number for paginated results

pageSizeinteger

Page size for paginated results

Response

OK

inSuburbboolean nullable

Gets or Sets InSuburb

querySuburbstring nullable

Gets or Sets QuerySuburb

hasRecentlySoldboolean nullable

Gets or Sets HasRecentlySold

idinteger nullable

Gets or Sets Id

namestring nullable

Gets or Sets Name

suburbstring nullable

Gets or Sets Suburb

logoUrlstring nullable

Gets or Sets LogoUrl

baseUrlstring nullable

Gets or Sets BaseUrl

address1string nullable

Gets or Sets Address1

address2string nullable

Gets or Sets Address2

telephonestring nullable

Gets or Sets Telephone

rentalTelephonestring nullable

Gets or Sets RentalTelephone

mobilestring nullable

Gets or Sets Mobile

faxstring nullable

Gets or Sets Fax

statestring nullable

Gets or Sets State

descriptionstring nullable

Gets or Sets Description

emailstring nullable

Gets or Sets Email

rentalEmailstring nullable

Gets or Sets RentalEmail

homePageSearchOptionsstring nullable

Gets or Sets HomePageSearchOptions

accountTypeinteger nullable

Gets or Sets AccountType

numberForSaleinteger nullable

Gets or Sets NumberForSale

numberForRentinteger nullable

Gets or Sets NumberForRent

domainUrlstring nullable

Gets or Sets DomainUrl

showTabSoldLastYearboolean nullable

Gets or Sets ShowTabSoldLastYear