API Versioning

How the Whatalo API handles versions and breaking changes.

Current Version

The current API version is v1. All endpoints are prefixed with /v1/:

https://api.whatalo.com/v1/products

Versioning Policy

  • Breaking changes are introduced only in new major versions (v2, v3, etc.)
  • Non-breaking additions (new fields, new endpoints) are added to the current version
  • Deprecations are announced at least 6 months before removal

What Counts as a Breaking Change

BreakingNon-Breaking
Removing a fieldAdding a new field
Changing a field typeAdding a new endpoint
Changing error codesAdding a new query parameter
Removing an endpointAdding a new optional field
Changing required fieldsAdding new enum values

Staying Up to Date

  • Subscribe to developer announcements in your Dashboard
  • Test integrations against the latest version regularly
  • Review the API overview for the full list of available resources

On this page