List valid suburbs for a specific page
GET /api/v5/locations/page/{page}
GET
/api/v5/locations/page/{page}
Returns a specific page of valid Australian suburb/postcode/state rows.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” page
required
string
Example
2Page number (1-based).
Query Parameters
Section titled “Query Parameters ” q
When present, the request is redirected to the location search endpoint.
string
When present, the request is redirected to the location search endpoint.
limit
Maximum suburb rows per page (1-5000); defaults to 1000.
string
Maximum suburb rows per page (1-5000); defaults to 1000.
Responses
Section titled “ Responses ”Paged suburb list
object
code
required
Status code echoed in the body; always 200 for a successful page.
number
next_page
Absolute URL of the next page of results; present only when the current page is full and more rows may exist.
string
prev_page
Absolute URL of the previous page of results; present only when the current page number is greater than 1.
string
locations
required
Suburb/locality rows for this page, ordered by postcode.
Array<object>
Invalid page number