---
title: "Retrieves business listings matching the specified criteria."
method: POST
path: "/v1/listings/business/_search"
tags: ["Listings"]
---

# Retrieves business listings matching the specified criteria.

`POST /v1/listings/business/_search`

## Request

- Base URL: `https://api.domain.com.au`
- URL: `https://api.domain.com.au/v1/listings/business/_search`
- Auth: one of:
  - API key in header `x-api-key`
  - OAuth 2
    - Authorization code: `https://auth.domain.com.au/v1/connect/authorize`
    - Client credentials
    - Token URL: `https://auth.domain.com.au/v1/connect/token` scopes: `api_listings_read`, `api_listings_write`
- TypeScript: <https://skmtc.dev/domain/apis/domain-public-api/docs/v1/listings/business/_search/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- DomainPublicAdapterWebApiModelsV1ListingsBusinessSearchRequest: Represents a CRE Business Search Request
  - `pageNumber` integer
  - `advertiserId` integer: AdvertiserId e.g. An Agency ID
  - `propertyTypes` string[]: Listing property types
  - `keywords` string[]: Search listings by keyword
  - `brandId` integer: The franchise brand ID
  - `franchiseGroupId` integer: The franchise group ID. A franchise group owns multiple franchise brands.
  - `locations` DomainPublicAdapterWebApiModelsV1ListingsBusinessLocationSearch[]: Location search criteria
    - `area` string: Location area
    - `postcode` string: Location postcode
    - `region` string: Location region
    - `state` 'act' | 'nsw' | 'qld' | 'vic' | 'sa' | 'wa' | 'nt' | 'tas': State
    - `suburb` string: Suburb
  - `pageSize` integer: Search results page size
  - `price` DomainPublicAdapterWebApiModelsV1ListingsBusinessPriceSearch: Search criteria. Price
    - `min` integer: Minimum price. null - no minimum price limit
    - `max` integer: Maximum price. null - no maximum price limit
  - `sort` 'default' | 'newestFirst' | 'lowTotalPriceFirst' | 'hightTotalPriceFirst' | 'suburbAsc' | 'suburbDesc': Sorting order
  - `searchMode` 'forSale' | 'franchiseOpportunity' | 'franchiseBrand': Search mode

## Response `200`

OK

- DomainPublicAdapterWebApiModelsV1ListingsBusinessListing[]
  - `ad` DomainPublicAdapterWebApiModelsV1ListingsBusinessAd: Listing details
    - `adType` string: Product type
    - `url` string: URL of property details page on CRE website
  - `price` string: Formatted listing price
  - `advertiser` DomainPublicAdapterWebApiModelsV1ListingsBusinessAdvertiser: Agency details
    - `address` string: agency address
    - `id` integer: Agency ID
    - `name` string: Agency Name
    - `preferredColorHex` string: Agency color
    - `images` DomainPublicAdapterWebApiModelsV1ListingsBusinessAdvertiserImages: Agency images (logos, banners)
      - `agencyBannerImageUrl` string: Agency branding banner image URL
      - `agencyBannerWideImageUrl` string: Not used
      - `logoUrl` string: Agency logo. Note: CRE has two logo sizes.
    - `contacts` DomainPublicAdapterWebApiModelsV1ListingsBusinessContact[]: Agency contacts
      - `id` integer: Agent identifier
      - `firstName` string: First name. Not available in CRE
      - `lastName` string: Last name. Not available in CRE
      - `imageUrl` string: Image URL
      - `displayFullName` string: Full name
      - `phoneNumbers` DomainPublicAdapterWebApiModelsV1ListingsBusinessPhoneNumber[]: Phone numbers
        - `displayLabel` string: Diplay label
        - `type` string: Type: \"fax\", \"mobile\", \"telephone\"
        - `number` string: Phone number
      - `emailAddress` string: E-mail address
      - `address` string: Full address
    - `isConjunctional` boolean: Checks whether advertiser is conjunctional or not
  - `geoLocation` DomainPublicAdapterWebApiModelsV1ListingsBusinessGeoLocation: Geographic coordinate
    - `latitude` number, double: Latitude
    - `longitude` number, double: Longitude
  - `propertyArea` string: Building size
  - `propertyType` string: Property type
  - `address` string: Full address
  - `headline` string: Headline
  - `hasVideo` boolean: Has video?
  - `media` DomainPublicAdapterWebApiModelsV1ListingsBusinessMedia[]: Media resources for listing (images, video, floor plans)
    - `dateCreated` string, date-time: Not used
    - `imageUrl` string: Resource URL
    - `mediaType` string: Media type: \"image\", \"video\"
    - `type` string: Type: \"youtube\", \"vimeo\", \"mp4\"
    - `videoUrl` string: Video URL
  - `auctionDate` string: Auction date
  - `id` integer: AdID
  - `metadata` DomainPublicAdapterWebApiModelsV1ListingsBusinessMetadata: Listing metadata
    - `addressComponents` DomainPublicAdapterWebApiModelsV1ListingsBusinessAddressComponents: Address components
      - `area` string: Listing Area
      - `district` string: Not used
      - `postcode` string: Postcode
      - `region` string: Listing Region
      - `stateShort` string: AUS State. 2 or 3 characters
      - `street` string: Street address
      - `streetNumber` string: Street number
      - `suburb` string: Suburb
      - `unitNumber` string: Unit number
  - `carspaceCount` integer: Car parking spaces count

---

[API](https://skmtc.dev/domain/apis/domain-public-api.md) - [All operations](https://skmtc.dev/domain/apis/domain-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/domain/apis/domain-public-api/revisions/133015c6842c?raw)