The API uses URL path versioning. The current version is v1.
Base URL
The version is part of every endpoint URL:
Compatibility promise
Within a version, we will not make breaking changes. You can rely on:
- Existing fields will not be removed or renamed
- Existing endpoints will not be removed
- Existing error codes will not change meaning
- Response shapes will not change
We may add new, non-breaking changes within a version:
- New optional fields on existing resources
- New endpoints
- New optional query parameters
- New error codes for new failure modes
Write your client code to ignore unknown fields. This ensures you’re forward-compatible when we add new response fields.
Deprecation policy
When we release a new version:
- The previous version enters a deprecation period of at least 6 months
- Deprecated versions include a
Sunset header with the retirement date
- We’ll notify you via email before sunsetting a version
Current versions
