WzGate
Build your own websiteAPI referenceProperties

Get units (properties) for a project

GET
/api/public/properties/projects/{id}/units

Path Parameters

id*string

Project ID

Query Parameters

q?string

Free-text search

sort?string
Default"newest"

Value in

  • "newest"
  • "oldest"
  • "price_asc"
  • "price_desc"
  • "delivery_asc"
locationIds?string

Location IDs (csv)

developerIds?string

Developer IDs (csv)

projectIds?string

Project IDs (csv)

unitTypeIds?string

Unit type IDs (csv)

amenityIds?string

Amenity IDs (csv) — ALL must be present

minPrice?number

Minimum price

maxPrice?number

Maximum price

minArea?number

Minimum area

maxArea?number

Maximum area

bedrooms?string

Bedroom counts (csv)

bathrooms?string

Bathroom counts (csv)

floors?string

Floors (csv); 0 = ground

finishing?string

Finishing states (csv)

saleType?string

primary = has a Unit, resale = has a SecondaryUnit

Value in

  • "primary"
  • "resale"
newLaunch?boolean

New-launch projects only

isFeature?boolean

Featured only

page?number
Range1 <= value
Default1
perPage?number
Range1 <= value <= 100
Default12

Header Parameters

X-Site*string

The site key identifying which website this request belongs to. May be omitted only when the request comes from a domain already verified for the site (the Origin/Host then resolves it), or when the deprecated X-Subdomain header is used.

X-Api-Key?string

Publishable (pk_…) or secret (sk_…) key for this site. Required on writes; accepted on reads. NOTE: currently rolling out in monitor mode — a write without a valid key is logged rather than refused, so this is documented as optional. It becomes required on writes when enforcement is switched on; send it now.

Response Body

curl -X GET "https://example.com/api/public/properties/projects/string/units" \  -H "X-Site: string"
Empty

Get buildings for a project

Previous Page

Get project by ID

Next Page