Skip to content

Versioning and changelog

The version is in the path: https://api.europlaybook.com/v1.

These changes can happen at any time. Write clients that tolerate them:

  • New endpoints, new optional query parameters, new optional request fields.
  • New fields in responses.
  • New values in enums that are documented as open (for example source, material codes, regimes). Treat an unknown value as “other”.
  • New error code values.

Removing or renaming a field, changing a type or meaning, or making an optional field required is a breaking change. Breaking changes go into a new version (https://api.europlaybook.com/v2). The previous version keeps working for a transition period that is announced in the changelog.

The MCP server follows the same rules for tool names and arguments.

Webhooks (signed event deliveries, so you do not need to poll) are planned; until then, poll the list endpoints, for example once an hour.

Changes are listed below, newest first. The OpenAPI document at /openapi.json always describes the current version.

Date Change
2026-10 OpenAPI paths are now relative to the server URL (/account instead of /api/public/v1/account); readable operationIds (list_products). The API itself did not change.
2026-10 Added: product group_id and confirmation; packaging lines source, source_ref, inherited, group_id; product-groups; product evidence and profiles (+ PUT proposal); periods/{id}/totals/{key}/explain. MCP: list_product_groups, explain_total.
2026-10 v1 contract published.