Upcoming Breaking API Changes

All upcoming breaking changes to the API are listed below, ordered by the effective date of the change.

2026/06/15 - Attendances permission changes

The permissions structure for attendances is being updated. Currently, attendances permissions are part of both the relations and enrollments permission hierarchies. This will change so that attendances permissions are only part of the enrollments hierarchy.

Permission affected	Current location	New location
Attendances permissions	Relations and Enrollments hierarchies	Enrollments hierarchy

Migration recommendations

Review and update your API scope and user role configurations to ensure attendances permissions are properly set after the change takes effect. If you currently rely on attendances permissions through the relations hierarchy, you will need to ensure appropriate enrollments permissions are configured. Viewing attendances will require enrollments:read permissions, while managing attendances will require enrollments:modify permissions after the change.

Last updated on 2026/02/16

TBD - Get personal program elements endpoint removal

The following endpoints/methods are deprecated and planned for removal:

Endpoint	Method
/api/v1/program/personal_program_elements	GET

Last updated on 2025/02/05

TBD - Affiliations endpoints removal

The following endpoints/methods are deprecated and planned for removal:

Endpoint	Method
/api/v1/affiliations	GET
/api/v1/affiliations	POST
/api/v1/affiliations/{id}	PATCH
/api/v1/affiliations/{id}	DELETE

Migration recommendations

Once the organization change is live for your Eduframe environment¹, switch from /api/v1/affiliations to /api/v1/organization_affiliations to ensure accurate user-organization relationships.

Last updated on 2025/07/31

TBD - Accounts endpoint changes

The following endpoint including all of its methods are planned for change of use:

Endpoint	Originally used for	Will be used for
/api/v1/accounts	Organizations & organization invoice address data	Invoice addresses

Migration recommendations

Once the organization change is live for your Eduframe environment¹ and you need:

1. Organizations, use /api/v1/organizations instead.
2. Invoice address details of an organization, get the primary_account_id for an organization and retrieve the primary account using /api/v1/accounts/{id} instead.

Last updated on 2025/08/01

---

tip

Want to prepare for the organization change? The feature can be activated on any test environment on request.

For further details, refer to the API documentation or contact Eduframe support.

---

Footnotes

1. The general go-live date of the organization change will be communicated via our newsletter and updated here. Custom go-live dates can be arranged with us directly. ↩ ↩²