Skip to main content

API Versioning

docs101 uses URI-path versioning. The API version is part of the URL:

https://docs101.com/api/v1/invoices
https://docs101.com/api/v1/customers

Current Version​

The current and only version is v1. All endpoints are served under /api/v1/.

Non-Breaking Changes​

The following changes happen within v1 and do not trigger a version bump:

  • New optional fields in responses
  • New endpoints
  • Bug fixes and performance improvements
  • New optional query parameters

These additions are backward-compatible — existing integrations continue to work without modification.

tip

Design your integration to ignore unknown fields in API responses. This ensures new optional fields do not break your code.

Breaking Changes​

A new API version (e.g., /api/v2/) is introduced when changes would break existing integrations:

  • Removing or renaming existing fields
  • Changing the data type or structure of a response
  • Renaming or removing endpoints
  • Changing required parameters

Migration & Deprecation​

When a new version is introduced:

  • A migration guide will document all breaking changes and how to update your integration
  • The previous version will remain available for a transition period to give you time to migrate
  • Deprecation timelines will be announced in advance
info

There is currently no planned v2. The v1 API is stable and actively maintained.