Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Agents

Gets listing using the contact id

get/v1/agents/{id}/listings

Path parameters

idinteger required

Id of the agent (contact)

Query parameters

dateUpdatedSincestring date-time

Filter to remove listings not updated since before the given date time

includedArchivedListingsboolean

Filter to remove listings that have been archived

pageNumberinteger

Page number for paginated results

pageSizeinteger

Page size for paginated results

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