DOdomain
Listings

Retrieve details of listing using the listing id

Changed on
get/v1/listings/{id}

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_listings_read, api_listings_write
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

Id of the listing

Response

OK

objective'sale' | 'rent' nullable

Gets or Sets Objective

status'unknown' | 'archived' | 'underOffer' | 'sold' | 'leased' | 'newDevelopment' | 'recentlyUpdated' | 'new' | 'live' | 'pending' | 'depositTaken' nullable

Gets or Sets Status

saleMode'buy' | 'rent' | 'share' | 'sold' | 'leased' | 'archived' nullable

Gets or Sets SaleMode

channel'residential' | 'commercial' | 'business' nullable

Gets or Sets Channel

idinteger required

The identifier which uniquely identifies the listing.

bathroomsnumber float nullable

Total number of bathrooms in the property

bedroomsnumber float nullable

Total number of bedrooms in the property; Studio apartments have a value of "0"

buildingAreastring nullable

The building area display value of the property e.g. 160 ha

buildingAreaSqmnumber double nullable

The properties building area in square meters

carspacesnumber float nullable

Total number of car spaces in the property.

dateAvailablestring date-time nullable

The date the property is available. DateTime is in a local timezone.

dateCreatedstring date-time nullable

The date/time the listing was created. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

dateUpdatedstring date-time nullable

The date/time the listing had major update. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

dateMinorUpdatedstring date-time nullable

When minor update applied to the listing. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

datePurgedstring date-time nullable

The date/time the listing was purged. It's only returned for archived listings. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

dateListedstring date-time nullable

The date/time last listed. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

descriptionstring nullable

The long description of the property provided by the advertiser.

devProjectIdinteger nullable

The ID of the development project - null if no associated project

energyEfficiencyRatinginteger nullable

Energy Efficiency Rating value for ACT properties

featuresstring[] nullable

The property features specified by the advertiser

headlinestring nullable

The short description of the property provided by the advertiser.

isNewDevelopmentboolean nullable

Indicates whether the property is a new development

landAreastring nullable

The land area display string for the property e.g. 160 sqm

landAreaSqmnumber double nullable

The properties land area in square meters

propertyIdstring nullable

The identifier which uniquely identifies the property being advertised. This may be empty if the Address of property is poorly described

propertyTypesstring[] required

Types of the property

isWithdrawnboolean nullable

Indicates if the property has been withdrawn from the market The value will be 'true' When a listing is taken off market without being sold or leased.

seoUrlstring nullable

Listing SEO URL

virtualTourUrlstring nullable

The Listing's Virtual Tour URL.

homepassEnabledboolean nullable

If Homepass is enabled for the listing (agency)

numberOfDwellingsinteger nullable

Number of dwellings for current listing

highlightsstring[] nullable

Highlight items for the listing

Changes

  • 7130302fb268Revision changes
    • warning

      added the new accessoriesParts enum value to the / response property for the response status

    • warning

      added the new accommodationTourism enum value to the / response property for the response status

    • warning

      added the new accounting enum value to the / response property for the response status

    • warning

      added the new adult enum value to the / response property for the response status

    • warning

      added the new advertisingMarketing enum value to the / response property for the response status

    • warning

      added the new aerial enum value to the / response property for the response status

    • warning

      added the new aeronautical enum value to the / response property for the response status

    • warning

      added the new agedCare enum value to the / response property for the response status

    • warning

      added the new agricultural enum value to the / response property for the response status

    • warning

      added the new air enum value to the / response property for the response status

    • warning

      added the new aircraft enum value to the / response property for the response status

    • warning

      added the new alarms enum value to the / response property for the response status

    • warning

      added the new alcoholGrocery enum value to the / response property for the response status

    • warning

      added the new alcoholLiquor enum value to the / response property for the response status

    • warning

      added the new amusements enum value to the / response property for the response status

    • warning

      added the new animalRelated enum value to the / response property for the response status

    • warning

      added the new aquaticMarineMarinaBerth enum value to the / response property for the response status

    • warning

      added the new artsCrafts enum value to the / response property for the response status

    • warning

      added the new autoElectrical enum value to the / response property for the response status

    • warning

      added the new automotive enum value to the / response property for the response status

    • warning

      added the new backpackerHostel enum value to the / response property for the response status

    • warning

      added the new bakery enum value to the / response property for the response status

    • warning

      added the new barsNightclubs enum value to the / response property for the response status

    • warning

      added the new beautyHealth enum value to the / response property for the response status

    • warning

      added the new beautyProducts enum value to the / response property for the response status

    • warning

      added the new beautySalon enum value to the / response property for the response status

    • warning

      added the new bikeAndMotorcycle enum value to the / response property for the response status

    • warning

      added the new boardingKennels enum value to the / response property for the response status

    • warning

      added the new boatsMarineMarinaBerth enum value to the / response property for the response status

    • warning

      added the new bookkeeping enum value to the / response property for the response status

    • warning

      added the new brokerage enum value to the / response property for the response status

    • warning

      added the new builder enum value to the / response property for the response status

    • warning

      added the new buildingAndConstruction enum value to the / response property for the response status

    • warning

      added the new bus enum value to the / response property for the response status

    • warning

      added the new butcher enum value to the / response property for the response status

    • warning

      added the new cafeCoffeeShop enum value to the / response property for the response status

    • warning

      added the new cafeRestaurants enum value to the / response property for the response status

    • warning

      added the new car enum value to the / response property for the response status

    • warning

      added the new carBusTruck enum value to the / response property for the response status

    • warning

      added the new carDealership enum value to the / response property for the response status

    • warning

      added the new carRental enum value to the / response property for the response status

    • warning

      added the new carSpace enum value to the / response property for the response status

    • warning

      added the new carWash enum value to the / response property for the response status

    • warning

      added the new caravanPark enum value to the / response property for the response status

    • warning

      added the new carpenter enum value to the / response property for the response status

    • warning

      added the new catering enum value to the / response property for the response status

    • warning

      added the new childCare enum value to the / response property for the response status

    • warning

      added the new civil enum value to the / response property for the response status

    • warning

      added the new cleaning enum value to the / response property for the response status

    • warning

      added the new cleaningAndMaintenance enum value to the / response property for the response status

    • warning

      added the new clinicalPractice enum value to the / response property for the response status

    • warning

      added the new clothingAccessories enum value to the / response property for the response status

    • warning

      added the new clothingFootwear enum value to the / response property for the response status

    • warning

      added the new communication enum value to the / response property for the response status

    • warning

      added the new communications enum value to the / response property for the response status

    • warning

      added the new computerAndInternet enum value to the / response property for the response status

    • warning

      added the new computerIT enum value to the / response property for the response status

    • warning

      added the new construction enum value to the / response property for the response status

    • warning

      added the new convenienceStore enum value to the / response property for the response status

    • warning

      added the new copyLaminate enum value to the / response property for the response status

    • warning

      added the new courier enum value to the / response property for the response status

    • warning

      added the new cropHarvesting enum value to the / response property for the response status

    • warning

      added the new customs enum value to the / response property for the response status

    • warning

      added the new deli enum value to the / response property for the response status

    • warning

      added the new dental enum value to the / response property for the response status

    • warning

      added the new detailing enum value to the / response property for the response status

    • warning

      added the new discountStore enum value to the / response property for the response status

    • warning

      added the new distributors enum value to the / response property for the response status

    • warning

      added the new drivingSchools enum value to the / response property for the response status

    • warning

      added the new ecoFriendly enum value to the / response property for the response status

    • warning

      added the new educationTraining enum value to the / response property for the response status

    • warning

      added the new educational enum value to the / response property for the response status

    • warning

      added the new electrical enum value to the / response property for the response status

    • warning

      added the new employmentRecruitment enum value to the / response property for the response status

    • warning

      added the new entertainment enum value to the / response property for the response status

    • warning

      added the new entertainmentTechnology enum value to the / response property for the response status

    • warning

      added the new export enum value to the / response property for the response status

    • warning

      added the new farming enum value to the / response property for the response status

    • warning

      added the new fertiliser enum value to the / response property for the response status

    • warning

      added the new finance enum value to the / response property for the response status

    • warning

      added the new financialServices enum value to the / response property for the response status

    • warning

      added the new floristNursery enum value to the / response property for the response status

    • warning

      added the new foodBeverage enum value to the / response property for the response status

    • warning

      added the new foodBeverageHospitality enum value to the / response property for the response status

    • warning

      added the new franchiseBusinessOpportunities enum value to the / response property for the response status

    • warning

      added the new freight enum value to the / response property for the response status

    • warning

      added the new fruitPicking enum value to the / response property for the response status

    • warning

      added the new fruitVegFreshProduce enum value to the / response property for the response status

    • warning

      added the new functionCentre enum value to the / response property for the response status

    • warning

      added the new furnitureTimber enum value to the / response property for the response status

    • warning

      added the new gambling enum value to the / response property for the response status

    • warning

      added the new gardenHousehold enum value to the / response property for the response status

    • warning

      added the new gardenNurseries enum value to the / response property for the response status

    • warning

      added the new gardening enum value to the / response property for the response status

    • warning

      added the new glassCeramic enum value to the / response property for the response status

    • warning

      added the new green enum value to the / response property for the response status

    • warning

      added the new grocery enum value to the / response property for the response status

    • warning

      added the new guestHouseBB enum value to the / response property for the response status

    • warning

      added the new hairdresser enum value to the / response property for the response status

    • warning

      added the new healthBeauty enum value to the / response property for the response status

    • warning

      added the new healthSpa enum value to the / response property for the response status

    • warning

      added the new hire enum value to the / response property for the response status

    • warning

      added the new homeGarden enum value to the / response property for the response status

    • warning

      added the new homewareHardware enum value to the / response property for the response status

    • warning

      added the new hospital enum value to the / response property for the response status

    • warning

      added the new hotel enum value to the / response property for the response status

    • warning

      added the new huntingTrap enum value to the / response property for the response status

    • warning

      added the new import enum value to the / response property for the response status

    • warning

      added the new importExportWholesale enum value to the / response property for the response status

    • warning

      added the new industrialManufacturing enum value to the / response property for the response status

    • warning

      added the new insemination enum value to the / response property for the response status

    • warning

      added the new insurance enum value to the / response property for the response status

    • warning

      added the new internationalCommercial enum value to the / response property for the response status

    • warning

      added the new internet enum value to the / response property for the response status

    • warning

      added the new juiceBar enum value to the / response property for the response status

    • warning

      added the new landClearing enum value to the / response property for the response status

    • warning

      added the new landscaping enum value to the / response property for the response status

    • warning

      added the new laundryDryCleaning enum value to the / response property for the response status

    • warning

      added the new legal enum value to the / response property for the response status

    • warning

      added the new leisureEntertainment enum value to the / response property for the response status

    • warning

      added the new limousineTaxi enum value to the / response property for the response status

    • warning

      added the new machinery enum value to the / response property for the response status

    • warning

      added the new machineryMetal enum value to the / response property for the response status

    • warning

      added the new managementRights enum value to the / response property for the response status

    • warning

      added the new manufacturers enum value to the / response property for the response status

    • warning

      added the new manufacturingEngineering enum value to the / response property for the response status

    • warning

      added the new marine enum value to the / response property for the response status

    • warning

      added the new massage enum value to the / response property for the response status

    • warning

      added the new mechanicalRepair enum value to the / response property for the response status

    • warning

      added the new media enum value to the / response property for the response status

    • warning

      added the new medical enum value to the / response property for the response status

    • warning

      added the new medicalPractice enum value to the / response property for the response status

    • warning

      added the new miningEarthMoving enum value to the / response property for the response status

    • warning

      added the new mobileServices enum value to the / response property for the response status

    • warning

      added the new motel enum value to the / response property for the response status

    • warning

      added the new motorcycle enum value to the / response property for the response status

    • warning

      added the new musicRelated enum value to the / response property for the response status

    • warning

      added the new mustering enum value to the / response property for the response status

    • warning

      added the new nails enum value to the / response property for the response status

    • warning

      added the new naturalTherapies enum value to the / response property for the response status

    • warning

      added the new newsagency enum value to the / response property for the response status

    • warning

      added the new nursery enum value to the / response property for the response status

    • warning

      added the new nursingHome enum value to the / response property for the response status

    • warning

      added the new officeSupplies enum value to the / response property for the response status

    • warning

      added the new oilGas enum value to the / response property for the response status

    • warning

      added the new panelBeating enum value to the / response property for the response status

    • warning

      added the new paperPrinting enum value to the / response property for the response status

    • warning

      added the new pestRelated enum value to the / response property for the response status

    • warning

      added the new pharmacies enum value to the / response property for the response status

    • warning

      added the new plastic enum value to the / response property for the response status

    • warning

      added the new plumbing enum value to the / response property for the response status

    • warning

      added the new poolWater enum value to the / response property for the response status

    • warning

      added the new postOffices enum value to the / response property for the response status

    • warning

      added the new printPhoto enum value to the / response property for the response status

    • warning

      added the new professional enum value to the / response property for the response status

    • warning

      added the new propertyRealEstate enum value to the / response property for the response status

    • warning

      added the new rail enum value to the / response property for the response status

    • warning

      added the new recreationSport enum value to the / response property for the response status

    • warning

      added the new recruitment enum value to the / response property for the response status

    • warning

      added the new repair enum value to the / response property for the response status

    • warning

      added the new resort enum value to the / response property for the response status

    • warning

      added the new restaurant enum value to the / response property for the response status

    • warning

      added the new retailer enum value to the / response property for the response status

    • warning

      added the new retirementVillage enum value to the / response property for the response status

    • warning

      added the new road enum value to the / response property for the response status

    • warning

      added the new scientific enum value to the / response property for the response status

    • warning

      added the new sea enum value to the / response property for the response status

    • warning

      added the new security enum value to the / response property for the response status

    • warning

      added the new serviceStation enum value to the / response property for the response status

    • warning

      added the new services enum value to the / response property for the response status

    • warning

      added the new shearing enum value to the / response property for the response status

    • warning

      added the new specialityRetail enum value to the / response property for the response status

    • warning

      added the new sportsComplexGym enum value to the / response property for the response status

    • warning

      added the new storage enum value to the / response property for the response status

    • warning

      added the new supermarket enum value to the / response property for the response status

    • warning

      added the new takeawayFood enum value to the / response property for the response status

    • warning

      added the new taxi enum value to the / response property for the response status

    • warning

      added the new themePark enum value to the / response property for the response status

    • warning

      added the new tours enum value to the / response property for the response status

    • warning

      added the new training enum value to the / response property for the response status

    • warning

      added the new transportDistribution enum value to the / response property for the response status

    • warning

      added the new travel enum value to the / response property for the response status

    • warning

      added the new travelAgency enum value to the / response property for the response status

    • warning

      added the new truck enum value to the / response property for the response status

    • warning

      added the new varietyStore enum value to the / response property for the response status

    • warning

      added the new vending enum value to the / response property for the response status

    • warning

      added the new water enum value to the / response property for the response status

    • warning

      added the new welding enum value to the / response property for the response status

    • warning

      added the new wholesale enum value to the / response property for the response status

    • warning

      added the new wholesalers enum value to the / response property for the response status

    • warning

      added the new woolClassing enum value to the / response property for the response status

    • warning

      added the new wreckers enum value to the / response property for the response status

    • info

      removed the carspace enum value from the / response property for the response status

    • info

      removed the international enum value from the / response property for the response status