ZapyFlow/API documentationopenapi.json

Versioning

This reference describes version 2026-10-12. There is no version segment in the URL.

Why there is no /v1

A version in the path is a promise to run two servers. We would rather promise something we can keep: additive changes only, plus a written deprecation path for anything that has to go.

What can change without warning

  • New endpoints, new optional request fields, new response fields.
  • New values in an enum you only read (never in one you send).
  • New event types in the catalog and new headers on webhook deliveries.
Write your client so that unknown response fields are ignored and unknown event names are skipped. A client that rejects unfamiliar keys will break on a change that breaks nobody else.

What counts as breaking, and how you find out

Removing a field or endpoint, renaming anything, tightening validation, or changing a status code. Those get: an announcement to the workspace owner's email, a Deprecation and Sunset header on the affected responses, and at least 90 days before the change lands.

Version numbers are dates

2026-10-12 is the day this document was generated from the server. It answers the only question a date needs to answer — is this newer than what I read last time — and nobody has to remember to bump it.