API Versioning
Our commitment to API stability and how we handle changes.
Current Version
The current API version is v1. The version is included in the URL path for all endpoints.
Version Header
Every API response includes a header indicating the version:
What Triggers a New Version?
We create a new API version for breaking changes that would affect existing integrations:
Breaking Changes (New Version)
- • Removing an endpoint
- • Removing a response field
- • Changing a field's type
- • Changing authentication method
- • Changing error response format
Non-Breaking (Same Version)
- • Adding new endpoints
- • Adding new optional fields
- • Adding new query parameters
- • Bug fixes
- • Performance improvements
Deprecation Policy
When we deprecate an API version, we follow this timeline:
Announcement
Email notification to all users with new version details and migration guide.
Deprecation Warning
Responses include a X-API-Deprecated header. Old version continues working normally.
Reminder
Email reminder to users still on the old version.
Sunset
Old version is discontinued. Requests return a 410 Gone response with migration instructions.
Our Stability Commitment
12-Month Support Guarantee
Every API version is supported for at least 12 months after a new version is released. You'll always have ample time to migrate your integration.
Changelog
Initial Release
- • List and search golf courses
- • Get course details with tee data
- • GPS hole coordinates (Pro/Enterprise)
- • Rate limiting and usage tracking
Questions?
If you have questions about API versioning or need help with migration, contact us at support@golfly.dev.