Versioning

API Versioning at Fieldwire

When new features are introduced sometimes it causes backwards-incompatible changes to our existing APIs. All requests will use the latest V3 version as described in the API Reference.

In order to use an older version of the API, specify a Fieldwire-Version HTTP Header with your request. 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.

curl --request POST \
  --url https://console.fieldwire.net/api/v3/projects \
  --header 'accept: application/json' \
  --header 'authorization: Authorization' \
  --header 'content-type: application/json'\
  --header 'Fieldwire-Version: 2020-06-23'

Minor Version Changelog

2021-03-30

The default response back from these endpoints will return Floorplan without the active Sheet embedded.

  • GET /api/v3/projects/:project_id/floorplans
  • GET /api/v3/projects/:project_id/floorplans/:floorplan_id
  • PATCH /api/v3/projects/:project_id/floorplans/:floorplan_id
  • PUT /api/v3/projects/:project_id/floorplans/:floorplan_id/restore
  • PUT /api/v3/projects/:project_id/floorplans/:floorplan_id/rotate

Backward Compatibility:
Set Fieldwire-Version: <dddd-mm-dd> to less than 2021-03-30 to get back Sheets embedded or call it with a query parameter ?with_current_sheet=true

GET /api/v3/projects/:project_id/floorplans?with_current_sheet=true
GET /api/v3/projects/:project_id/floorplans/:floorplan_id?with_current_sheet=true

Updated about a month ago


Versioning


API Versioning at Fieldwire

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.