getPostcodes

Retrieves a list of postcodes. Supports filtering by country, state, locality, or postcode.

Request

GET /rest/refdata/postcodes

Query Parameters

Provide one of the following:

Parameter	Type	Required	Description
isoCode	string	One of	ISO country code, e.g. AU
stateCode	string	One of	State code, e.g. AU-NSW
locality	string	One of	Suburb or partial suburb name, e.g. Randwick
postcode	string	One of	Postcode value, e.g. 2031

Examples

GET /rest/refdata/postcodes?isoCode=AU
GET /rest/refdata/postcodes?stateCode=AU-NSW
GET /rest/refdata/postcodes?locality=Randwick
GET /rest/refdata/postcodes?postcode=2031

Response

200 OK

Returns an array of postcode records matching the filter criteria.

Errors

Exception	Cause
WSRefDataServiceException	Service error while fetching postcodes

Version

GET /rest/refdata/postcodes/version

{ "version": 1 }