v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Projects

Searches projects

Note that the result page size is clamped at 100. Requesting a page size greater than this will be treated as if only a page size of 100 were requested.

get/v1/projects

Query parameters

agencyIdinteger

Restricts to the provided agency

pageNumberinteger

Page number for paginated results

pageSizeinteger

Page size for paginated results

projectStatus'live' | 'inActive'

The set of projects to return, defaults to live only

Response

OK

projectProfileType'noProfile' | 'projectProfileStandard' | 'projectProfilePremium' nullable

Gets or Sets ProjectProfileType

estimatedCompletionTertile'early' | 'mid' | 'late' nullable

Gets or Sets EstimatedCompletionTertile

category'houseAndLand' | 'apartment' | 'retirement' nullable

Gets or Sets Category

idinteger nullable

Project ID

namestring nullable

Project Name

startDatestring date-time nullable

Start date. DateTime is in a local timezone.

endDatestring date-time nullable

End date.DateTime is in a local timezone.

propertyTypesstring[] nullable

Property types available at the project.

enquiryEmailAddressstring nullable

Enquiry email address

projectUrlstring nullable

Project URL

headlinestring nullable

Headline

taglinestring nullable

Tag line

displayAsLastUpdatedstring date-time nullable

The 'last updated' date to show to customers. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

modifiedBystring nullable

Last updated by

modifiedDatestring date-time nullable

Last updated, used for auditing. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

createdBystring nullable

Created by

createdDatestring date-time nullable

Created date. DateTime is in AEST (Australian Eastern Standard Time) or AEDT (Australian Eastern Daylight Time) timezone.

backgroundColourstring nullable

Background colour

descriptionstring nullable

Description

appointmentRequiredboolean nullable

If inspections require an appointment.

featuresstring[] nullable

Features

priceFromnumber double nullable

Price from

priceTonumber double nullable

Price to

bannerUrlstring nullable

Banner URL

bigBannerUrlstring nullable

Big banner URL

smallBannerUrlstring nullable

Small banner URL

logoUrlstring nullable

Logo URL

numberOfFloorsinteger nullable

Maximum number of floors

minNumberOfFloorsinteger nullable

Minimum number of floors

minBuildingHeightinteger nullable

Minimum building height

maxBuildingHeightinteger nullable

Maximum building height

numberOfBuildingsinteger nullable

Number of buildings

numberOfApartmentsinteger nullable

Number of apartments

estimatedCompletionDatestring date-time nullable

Estimated completion date. DateTime in a local timezone.

startingPricenumber double nullable

Lowest child listing price

childListingIdsinteger[] nullable

Child listing identifiers.

linkedProjectIdsinteger[] nullable

Linked project identifiers.