Printeers

API Versioning

Understand how Printeers versions the API, the release cycle, and what to expect when upgrading.

The Printeers API follows Semantic Versioning. Beta preview releases use the -beta suffix (e.g., 2.0.0-beta.1).

Selecting a Version

The API version is specified in the URL path:

  • V1 (stable): https://api.printeers.com/v1/...
  • V2 (beta): https://api.printeers.com/v2/...

Each major version has its own base path. Minor and patch versions are applied automatically—you always get the latest stable release within your chosen major version.

Version Lifecycle

The following diagram illustrates how API versions progress through their lifecycle:

Version Lifecycle

Beta Preview

New major versions are first released as a public beta preview. During the beta phase:

  1. The current stable version becomes frozen (no new features).
  2. New features are added only to the beta preview.
  3. Bug fixes and security patches continue for the frozen version.

Stable

Once a beta preview is declared stable (the -beta suffix is removed), new non-breaking features are added through minor version increments. Breaking changes are reserved for the next major version.

Deprecation

When a new major version becomes stable, the previous major version enters a one-year deprecation period before being retired.

During this period:

  • The deprecated version continues to function normally.
  • Security patches are applied as needed.
  • No new features or non-critical bug fixes are made.

Release Cadence

V1 maintained backwards compatibility for nearly 10 years. While we're proud of that stability, it resulted in a larger gap between V1 and V2.

Going forward, we may release new major versions occasionally—roughly once per year at most. When we do, each release will contain only a few breaking changes, keeping upgrades simple. Combined with the one-year deprecation period, you'll always have plenty of time to migrate.

Changelog

Each version has a changelog documenting all changes. For major versions, the changelog includes migration information:

  • Breaking changes and how to address them.
  • Deprecated endpoints and their replacements.
  • New required fields or changed data formats.

Review the changelog before upgrading to understand what has changed and what actions you need to take.

Staying Informed

We notify API users about upcoming changes via email. Major releases, deprecation notices, and security advisories are sent to the email addresses configured in your organization.

Beta Feedback

We encourage API users to test beta versions before they become stable. If you encounter issues or have feedback:

  • Report bugs via support@printeers.com.
  • Include your organization name and the beta version number in your report.