Versioning

The version is part of the path: every endpoint lives under /api/public/v1.

Most changes within v1 are additive. These can happen at any time, and your code should tolerate them:

• New endpoints.
• New attributes, relationships, includes, filters and sorts.
• New values in meta, including new reason_code values in meta.skipped.
• New optional request fields.
• Better wording in detail messages.

The Public API is in beta. While it is, breaking changes can also happen within v1: removing or renaming an attribute or endpoint, changing a type, or making an optional field required.