Versioning & deprecation

The TrackScore.AI™ API is versioned in the URL path. The current and only version is /api/v1. Integrations built on v1 keep working for at least 12 months after any successor is announced.

Within a version: additive only

Inside v1 we only make additive changes: new endpoints, new optional request fields, and new response fields. Nothing is renamed, removed, or retyped within a version.

Because responses can gain fields at any time, clients must ignore unknown JSON fields. Every official SDK and the code samples in the reference follow this rule.

Breaking changes mint a new version

A breaking change ships as a new path version (for example /api/v2). From the day a successor is announced, v1 responses carry the RFC 8594 deprecation headers:

Deprecation: true
Sunset: Sat, 01 Aug 2027 00:00:00 GMT

The Sunset date is always at least 12 months out. Until that date, the deprecated version keeps serving requests unchanged.

Current versions

Version	Status	Sunset date
v1	Active (current)	None scheduled

How to stay compatible

• Ignore unknown fields in every JSON response and webhook payload.
• Match errors on error.code, never on message text.
• Dedupe webhooks on the event id; delivery is at-least-once.
• Watch for Deprecation and Sunset headers in responses.

Last updated 2026-07-20 · This page is the source of truth referenced by the OpenAPI spec and the API terms.