Versioning

We periodically release new, dated versions of the API whenever we make breaking changes. Although we try to only make backward-compatible changes, sometimes we have to make a breaking change to iterate on the API.

Type of Backward Compatible Changes

  • Adding new API endpoints
  • Adding new optional parameters to existing endpoints
  • Adding new data elements to existing responses
  • Adding new response codes
  • Adding new enum values
  • Changing the length or content of any API identifier

Continuity

You can then continue to use the old API version, or update your application to upgrade to the new Woodcore API version.