Skip to main content

API Versioning

The Spoke Connect API is versioned in the format vX. The current version is v1, and it is included in every request path (/connect/v1/...).

Spoke will not bump the version for backwards-compatible changes. Your integration should keep working when any of these happen:

  • Adding a new field to a response model
  • Adding a new value to an enum field
  • Adding a new endpoint
  • Adding a new resource or model
  • Adding a new non-required body field or query parameter to an existing endpoint
  • Increasing a limit on an endpoint (for example the maximum page size, but not the default)
  • Changing the rate limit of an endpoint

A new version is only introduced for a change that breaks one of these guarantees. When that happens, the previous version keeps working while you migrate.