Skip to main content
GET
List agency packages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Token authentication using format: Bearer <api_key>

Query Parameters

limit
integer
default:40

Number of packages per page

Required range: 1 <= x <= 5000
states
string

Comma-separated Australian states (also accepts singular 'state' param)

Example:

"NSW,QLD"

regions
string

Comma-separated region names

Example:

"Western Sydney"

suburbs
string

Comma-separated suburb names

Example:

"Marsden Park"

bedrooms
string

Comma-separated bedroom counts

Example:

"3,4"

building_types
string

Comma-separated property types

Example:

"House,Townhouse"

tags
string

Comma-separated category or contract type tags

Example:

"Premium,Turnkey"

suppliers
string

Comma-separated supplier names

statuses
string

Comma-separated build statuses

Example:

"available"

from_price
integer

Minimum package price

Example:

500000

to_price
integer

Maximum package price

Example:

800000

sort
enum<string>

Sort order (defaults to listed_desc)

Available options:
price_asc,
price_desc,
listed_asc,
listed_desc,
verified_asc,
verified_desc
page
integer
default:0

Page number (0-indexed)

Required range: x >= 0
include_facets
boolean
default:false

Include filter facets with counts (adds ~9 queries, cached for 5 minutes). Request once to build filter UI, omit on pagination.

Response

successful

data
object[]
required
meta
object
required
facets
object

Available filter values with counts for building filter UI