Versioning

All API calls to Fieldwire are expected to carry a version in the form of Fieldwire-Version request header. This header is a date formatted in the form of YYYY-MM-DD. Given a date, it will resolve to the next available API version. When just starting to use the Fieldwire API, you could use the current date as the version. For example, if the API usage is started on Dec 25, 2023, this header value would be 2023-12-25.

🚧

If the Fieldwire-Version header is not provided, the call will use the latest version by default. This may cause issues if new versions are introduced (see below)

When new features are introduced sometimes it causes backwards-incompatible changes to our existing APIs. Whenever this happens, we would introduce a new minor version. In order to use such an older version of the API, specify a date corresponding to that minor version. Here is an example request using a minor version introduced in 2020:

curl --request POST \
  --url /api/v3/projects \
  --header 'accept: application/json' \
  --header 'authorization: Authorization <access_token>' \
  --header 'content-type: application/json'\
  --header 'Fieldwire-Version: 2020-06-23'

The changelog here describes our minor version changes