Policies

Versioning

What may change inside v1 and how breaking changes are announced.

The version is in the path: /v1. Within v1 we only make additive changes — new endpoints, new fields, new optional parameters, new enum values. Your client should ignore unknown fields.

What counts as breaking

Removing or renaming a field, changing a field's type or unit, making a parameter required, or changing default behaviour. These ship as /v2 with at least six months of overlap, announced in the changelog and by email to dashboard users.

Deprecation

Deprecated endpoints keep working for the overlap period and return a deprecation header with the sunset date.