Skip to main content
The major version in the URL is Floral’s compatibility boundary. Existing /api/v1 integrations can adopt compatible additions without changing their base path.

​
Changes within v1

Floral may add:
  • new operations;
  • optional request fields and filters;
  • response fields; and
  • enum values where the field documentation permits expansion.
Clients should ignore response fields they do not recognize and handle unknown enum values safely when the field is documented as extensible. Floral does not remove or rename existing v1 operations or fields without a major-version migration.

​
Deprecation notice

Planned breaking changes use a new major path and at least 180 days of overlap. Floral publishes the replacement, migration steps, effective date, and support channel before the overlap begins. When an operation enters deprecation, its API reference identifies the replacement. Floral will also announce the change to affected integrators. A confirmed security or privacy issue may require a shorter window; Floral will provide the safest available migration path and communicate the exception.

​
Preparing clients

  • Keep the API base path configurable.
  • Parse only the fields your integration needs.
  • Retain request IDs and resource versions in logs.
  • Test the replacement before moving production traffic.
  • Do not assume undocumented behavior remains stable.