Skip to content
Esc
↑↓navigate↵open⌘Jpreview
On this page

Versioning and compatibility

How the Doss API is versioned and which changes count as backward-compatible.

The API version is part of the URL (/v1). Doss doesn’t make breaking changes within a version. If a breaking change is ever needed, it ships in a new version, and the previous version stays available for 1 month with notice in the changelog.

Doss considers these changes backward-compatible and may make them at any time. Build your integration to handle them:

  • Adding new endpoints
  • Adding new optional request parameters
  • Adding new properties to response objects
  • Adding new values to enum fields and new error types
  • Changing the order of properties in a response
  • Changing the length or format of IDs and cursors

Tables and fields are configured by your organization, so a field can be added, renamed or removed in Doss at any time. Read the table schema rather than assuming a fixed set of fields.