Skip to main content
The PanoFlow API is versioned in the URL. Within /v1, changes are additive only, so an integration written today keeps working as the API grows, as long as your client tolerates the additions listed below.

​
Additive changes

These can ship in /v1 at any time:
  • New endpoints
  • New optional request and response fields
  • New enum values, including new status, status_reason and kind values
  • New error codes and response codes
  • New webhook event types
Write your client so that none of these break it: ignore fields you don’t know, and handle an unknown enum value, error code or event type gracefully instead of failing.

​
Breaking changes

Removing or renaming anything, or making an optional field required, is a breaking change. Breaking changes are never made in /v1; they go into a new version such as /v2.

​
Pinning a version date

You can send the optional PanoFlow-Version header with a date, for example PanoFlow-Version: 2026-11-01, to pin additive changes to that date.

​
Contract version

The API reference on this site is generated from the PanoFlow API contract, version v0.4.3. Every change to the contract gets a new version number and a changelog entry.