---
title: "Retrieves summary of agencies matching the specified criteria."
method: GET
path: "/v1/agencies"
tags: ["Agencies"]
---

# Retrieves summary of agencies matching the specified criteria.

`GET /v1/agencies`

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>

## Query parameters

- `q` string
- `pageNumber` integer
- `pageSize` integer

## Response `200`

OK

- AgenciesV2AgencySummary[]
  - `inSuburb` boolean, nullable — Gets or Sets InSuburb
  - `querySuburb` string, nullable — Gets or Sets QuerySuburb
  - `hasRecentlySold` boolean, nullable — Gets or Sets HasRecentlySold
  - `id` integer, nullable — Gets or Sets Id
  - `name` string, nullable — Gets or Sets Name
  - `suburb` string, nullable — Gets or Sets Suburb
  - `logoUrl` string, nullable — Gets or Sets LogoUrl
  - `baseUrl` string, nullable — Gets or Sets BaseUrl
  - `address1` string, nullable — Gets or Sets Address1
  - `address2` string, nullable — Gets or Sets Address2
  - `telephone` string, nullable — Gets or Sets Telephone
  - `rentalTelephone` string, nullable — Gets or Sets RentalTelephone
  - `mobile` string, nullable — Gets or Sets Mobile
  - `fax` string, nullable — Gets or Sets Fax
  - `state` string, nullable — Gets or Sets State
  - `description` string, nullable — Gets or Sets Description
  - `email` string, nullable — Gets or Sets Email
  - `rentalEmail` string, nullable — Gets or Sets RentalEmail
  - `homePageSearchOptions` string, nullable — Gets or Sets HomePageSearchOptions
  - `accountType` integer, nullable — Gets or Sets AccountType
  - `numberForSale` integer, nullable — Gets or Sets NumberForSale
  - `numberForRent` integer, nullable — Gets or Sets NumberForRent
  - `domainUrl` string, nullable — Gets or Sets DomainUrl
  - `showTabSoldLastYear` boolean, nullable — Gets or Sets ShowTabSoldLastYear

## Other responses

- `default` — Error

---

[API](https://skmtc.net/domain/apis/domain-public-api.md) · [All operations](https://skmtc.net/domain/apis/domain-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/domain/domain-public-api/revisions/24ab78aba827/schema)