Youform Catalog API
versioning policy.
This policy covers the public template catalog at youform.com/api/v1. Product account APIs and MCP have their own authentication, capabilities, and lifecycle.
Versions and compatibility
The current major version is v1. The unversioned /api route is a discovery index; integrations should use the versioned endpoints in the OpenAPI specification.
Breaking contract changes use a new major version in the URL. Compatible additions, documentation corrections, and catalog content refreshes may ship within v1. Ignore response fields you do not use, and do not depend on a fixed template count or a permanent search result order across releases.
Template metadata is a build-time snapshot. For pagination, keep the same filters and follow nextOffset until null. If a release changes the catalog during pagination, refresh your result set.
Deprecation and sunset notices
No public catalog endpoint is deprecated or scheduled for retirement.
When an endpoint is scheduled for deprecation, its notice will be published on this page with the affected version, replacement, migration steps, and any planned retirement date. Affected API responses will include a Deprecation header using the RFC 9745 date format and a link to the migration notice.
If service will end on a scheduled date, affected responses will also include a Sunset header using the RFC 8594 HTTP-date format. A deprecation notice alone does not mean the endpoint has stopped working. Active endpoints do not send retirement headers.
Caching and request limits
Follow the response’s Cache-Control header; successful catalog reads currently allow five minutes of caching. Reuse results and request only the pages you need.
No fixed per-client application quota is currently advertised for this public catalog. This is not a promise of unlimited API capacity. If infrastructure returns 429, honor Retry-After when present; otherwise retry with increasing delays and avoid repeated bursts. The catalog does not currently advertise a remaining-quota counter.
Errors and recovery
Errors under /api use RFC 9457 application/problem+json. Check the HTTP status, stable code, and resolution hint. Correct 400 queries, rediscover paths after 404, use GET or HEAD after 405, and retry unexpected 500 failures later.
Account API and MCP errors are handled by the product service. Follow their current documentation rather than applying the catalog contract to private account operations.
Policy updates and support
Published October 17, 2026. No retirement notice is active. For integration questions or a migration concern, contact [email protected].