Reference

Changelog

Every change to the API gets recorded here, along with the promise we make about what won't change.

How versioning works

The version is in the path. /v1 is a contract: you embed these URLs in your backend, so we treat their shape as something we are not free to change.

Within /v1, changes are additive only. We may add a new field to a response or a new optional parameter to a request. We will not rename a field, remove one, change its type, or change what an existing status code means. Anything that would require you to edit working code ships as /v2 instead, with the old version kept alive.

Write tolerant clients

Because new fields can appear, don't write code that fails on an unrecognised key. Read the fields you need and ignore the rest.

Changes

Nothing to report yet

The API is new, so there is no history to read. Every future change will be listed here with the date it shipped and what it means for code already calling us.

Because changes only ever add, you will never need to check this page to keep working code working. It is here for when you want to know what has become newly available.