Versioning and changelog
The integration API is versioned so that an integration you build today keeps working.
What may change within v1#
Within v1, MASK may add:
- endpoints;
- optional request fields;
- response fields;
- strings in enumerated fields and new error codes;
- rewordings of
messagetexts.
It does not remove or rename fields, change their meaning or type, or tighten a rule in a way that refuses requests v1 accepts, except to fix a security problem. That is why clients must ignore what they don't know.
Breaking changes#
A breaking change gets a new base path, /api/v1/integration/v2/…, announced in advance, with v1 kept alongside for a transition period.
The OpenAPI document changes with every contract change and is the precise reference; this site explains it.
Changelog#
| Date | Change |
|---|---|
| 2026-11-04 | v1: keys and scopes, reference data, employee, card, event, session and report reads; employee, membership and event writes; idempotency; per-key rate limits |
| 2026-11-05 | A 401's WWW-Authenticate realm is mask-integration; the admin_linked_employee message is reworded |