Skip to main content

APIs for Online Digital Services

API Reference Documents

Please use the documents listed below as a reference for understanding how the Department uses APIs to facilitate the flow of planning data between the NSW Planning Portal and the IT systems of its stakeholders.

API Versioning Policy 

The Department’s API Versioning Policy follows a three-digit version number format, with each number separated by a period.

The version number consists of MAJOR.MINOR.PATCH information where:

  • MAJOR version update which includes breaking API changes,
  • MINOR version when functionality is added in a backwards-compatible manner,
  • PATCH version is used for backwards-compatible bug fixes.

View the API Versioning Document 

Last updated : March 2022

Last updated: 16/08/2022