Versioning

The version is part of the path: /api/v1/.

What we promise within v1

• We add endpoints, optional request fields and response fields.
• We never remove or rename a field, change its type or change the meaning of a value.
• New enumeration values may appear. Treat unknown values as "other" rather than failing.

A change that breaks any of these ships as /api/v2/, announced in advance, with v1 kept running alongside it for a transition period.

Write your client to ignore response fields it does not recognise.

The internal application API

Other paths under /api/ serve the PACE application itself. They change with the product, they are not a partner contract, and partner tokens are refused there.

Specification

The OpenAPI 3 specification is the contract: /api/v1/schema/?format=json (YAML without ?format=json). It covers /api/v1/ only.