- Endpoint list — every endpoint of the selected version, with the latest stable version it belongs to and its current status.
- Release notes — the detailed history of changes, grouped by date.
How to read the endpoint list
- Route — the endpoint path, as you call it.
- Title — the endpoint name, as displayed in the API Reference tab.
- Latest stable — the most recent stable version the endpoint is part of;
previewif it has not been released in a stable version yet. - Status :
Stableonce the endpoint is part of a stable versionTestingwhile it is only available in previewDeprecatedwhen the endpoint is scheduled for removal — the status indicates the date at which the route will be removed (this date reflects the notice period defined in the API Terms of Use)
How to read the release notes
Each dated entry lists the affected endpoints and describes every change with a badge:NewNew version available
The endpoint is introduced in this version — or, on an older stable version, a newer revision of the endpoint exists (the entry tells you in which version).
Added
Something new on an existing endpoint (a parameter, a response field, a capability).
Changed
An existing behavior or contract element is modified.
Removed
The endpoint (or one of its elements) is removed — in the
preview version, this usually means it was migrated to a stable version.RequestResponse
Which part of the contract the change applies to.
Breaking change
The change is not backward compatible: your integration may require an update. Breaking changes normally only appear between stable versions; exceptionally, a stable route may receive one when a major bug has to be fixed, in accordance with the API Terms of Use.
The
preview version never flags breaking changes: preview endpoints carry no stability guarantee and may change without prior notice — see the Versioning guide.