Request Forms

API versioning and deprecation policy

How /api and /api/v1 are versioned, and how deprecation is signaled with RFC 9745 Deprecation and RFC 8594 Sunset headers.

The public REST API is versioned in the URL path. Discovery routes such as health, stats, and the catalog live at /api. Paid organization routes live at /api/v1. Breaking changes need a new major path such as /api/v2. Pin a client to a versioned path and read this policy before you store a route.

This is the deprecation and sunset policy. Current paths are not deprecated. There is no scheduled sunset for /api/v1. When a path is deprecated, responses on that path include the RFC 9745 Deprecation header with the date deprecation began. When a removal date is set, responses also include the RFC 8594 Sunset header with that HTTP date. The old path stays until the Sunset date.

Every public operation is listed in the OpenAPI document at /openapi.json. The JSON catalog at /api repeats those links and points back here. The CLI at /docs/cli and the MCP server at /mcp call the same versioned paths. Do not treat an unversioned guess as stable.

Questions about this policy go to support@requestforms.io. The canonical HTML copy is https://requestforms.io/docs/deprecation. Machine-readable copies are /deprecation.md and this docs page with Accept: text/markdown.

Same policy in docs