Search
K
Guides

API Versioning

Learn best practices for API versioning to manage changes, ensure stability, and support developers over time.

Why API Versioning Matters

API versioning allows your platform to evolve without breaking existing integrations. As APIs grow, changes to request formats, response structures, or business logic are inevitable. Versioning ensures that developers can continue using stable APIs while migrating to newer versions at their own pace.

A clear versioning strategy improves developer trust, reduces support overhead, and enables long-term platform scalability.

Explore our APIs

Connect, create, and innovate with our easy-to-use APIs.

Start building

When to Introduce a New Version

Not every change requires a new version. Introduce a new API version only when a breaking change is unavoidable.

Common breaking changes include:

  • Removing or renaming request fields
  • Changing response structures or data types
  • Modifying endpoint behavior
  • Changing authentication or authorization rules

Backward-compatible changes, such as adding optional fields, should not require a new version.

The most widely adopted and recommended approach is URI-based versioning.

Example:

POST /v1/submission
GET  /v1/entitysearch