API statuses
We release different versions of APIs as they’re developed and updated.
We give each API version a status to explain who can use it, and what you can expect from it.
Status meanings
Alpha
This version is being developed. You cannot subscribe to it yet, but you can read documentation and provide feedback before it’s released.
Beta
This version is available for use. Some versions stay in beta for a long time.
Changes might be made that are either:
- backwards-compatible, meaning they will not break your integration with the API
- breaking changes that will break your integration with the API
If breaking changes are made, you’ll need to update your application to integrate with the API again.
Subscribe to emails about the API to get information about changes.
Stable
This version is available for use. It may be updated, but any changes should not break your integration with the API.
Deprecated
This version has been replaced and will be removed. You should use the latest version of the API instead.
Private APIs
Some APIs are marked as ‘private’. This means they’re in development and you cannot subscribe to them in the Developer Hub.
API development teams may allow some users to access and test alpha, beta, trial or stable versions of private APIs however.
Contact our support team to request access to view full documentation and endpoints, and to use private APIs.