Ctrlk
Help CenterSystem StatusContact SupportYour Dashboard →
For the complete documentation index, see llms.txt. This page is also available as Markdown.

API Lifecycle Policy

Learn how GrowSurf versions the REST API and guarantees notice before breaking removals.

GrowSurf versions the REST API in the URL. The current base URL is https://api.growsurf.com/v2.

This policy takes effect on August 25, 2026.

Compatible changes

GrowSurf can add backward-compatible functionality within an existing API version. Examples include new endpoints, new optional request fields, and new response fields. Clients should ignore response fields they do not use.

A breaking contract change requires a new API version. GrowSurf can make an urgent breaking change with less notice only when security, privacy, legal, or service-integrity requirements make the existing behavior unsafe or unlawful.

Minimum notice

GrowSurf gives at least 12 calendar months of public notice before a planned breaking removal. The notice period starts when GrowSurf marks the affected surface as deprecated in the public OpenAPI schema and publishes the migration guidance. The removal date cannot be earlier than the same calendar date 12 months later.

The 12-month minimum does not apply to an urgent security, privacy, legal, or service-integrity change. GrowSurf will explain the exception and publish a migration path as early as practical.

Deprecation signals

When GrowSurf schedules a breaking removal, it uses these signals:

  • The OpenAPI operation, parameter, or schema field has deprecated: true.

  • Responses from the affected resource include an RFC 9745 Deprecation header with the deprecation timestamp.

  • A Link header with rel="deprecation" points to migration guidance.

  • If GrowSurf has set a removal date, responses include an RFC 8594 Sunset header with that date.

  • The API documentation identifies the replacement, migration steps, and known compatibility differences.

A deprecated feature can remain available without a scheduled removal. In that case, GrowSurf can mark it in OpenAPI and documentation without sending a Sunset header. The 12-month removal window starts when GrowSurf publishes the migration guidance and planned removal.

Client guidance

Check the OpenAPI schema during development and before dependency updates. Treat Deprecation as a migration signal. If a response also has Sunset, complete the migration before that date.

Contact GrowSurf Support if a published migration path does not cover your integration.

Last updated

Was this helpful?