API
Changelog and versioning
The path carries the major version. Additive changes ship without notice; breaking ones get a new version and an overlap period.
Versioning
The API is versioned in the path: /v1. Within a version we may at any time:
- add endpoints,
- add fields to responses,
- add optional fields to requests,
- add values to enums that are documented as open (destination types, scan properties).
Write clients that ignore unknown fields and unknown enum values. Anything that would break a correct client, such as removing a field or changing its type, ships as a new major version, with at least three months of overlap during which both versions work, announced here.
Changelog
2026-09-06
- Initial release of v1: workspace (
/me), codes with designed artwork download, folders, templates, scans and analytics, form submissions, webhooks and read-only KuikPages.