Skip to content

List locations by page

GET
/locations/page/{page}

Returns a paginated list of valid Australian suburbs. Use this for bulk fetching all locations — each page returns up to 1000 suburbs.

page
required
integer
>= 1

Page number (1-based)

Paginated list of suburbs

Array<object>
object
id

Unique location identifier

integer
Example
12345
postcode

Australian postcode (4 digits)

string
Example
2000
locality

Suburb or locality name (uppercase)

string
Example
SYDNEY
state

Australian state or territory abbreviation

string
Allowed values: NSW VIC QLD SA WA TAS NT ACT
Example
NSW
priority

Priority ranking for search result ordering

integer
Example
1