Skip to main content
GoSentrix APIs are versioned to ensure backward compatibility.

​
Version Format

APIs use URL-based versioning:
  • Current: /api/v1/
  • Future: /api/v2/, /api/v3/, etc.

​
Version Lifecycle

  1. Current: Actively supported, receives updates
  2. Deprecated: Still supported, no new features
  3. Sunset: Scheduled for removal (6+ months notice)

​
Deprecation Policy

  • Notice Period: Minimum 6 months before sunset
  • Communication: Email, changelog, API headers
  • Migration Guide: Provided for major versions
  • Support: Deprecated versions supported for 12 months

​
Version Headers

API responses include version information: 
API-Version: v1
Deprecation: true
Sunset: 2025-07-01

​
Best Practices

  • Always specify API version in requests
  • Monitor deprecation headers
  • Plan migrations early
  • Test new versions in sandbox
  • Subscribe to changelog updates