Upcoming API Changes

Planned changes

The catalog product endpoints currently return the attribute course_tab_contents.course_tab in the response. This is unintended and not in line with our API documentation. Removing this attribute is a breaking change.

The course_tab attribute will be removed from these endpoints. The course_tab_contents attribute will continue to be available as documented.

Endpoint	Method	Data removed	Effective date
/api/v1/catalog/product	GET	course_tab_contents.course_tab	1 January 2026
/api/v1/catalog/product/{id}	GET	course_tab_contents.course_tab	1 January 2026

Planned for removal

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

Endpoint	Method	Planned removal date
/api/v1/program/personal_program_elements	GET	To be defined
/api/v1/affiliations	GET	To be defined1
/api/v1/affiliations	POST	To be defined1
/api/v1/affiliations/{id}	PATCH	To be defined1
/api/v1/affiliations/{id}	DELETE	To be defined1

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.

Planned for change of use

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

Endpoint	Originally used for	Will be used for	Planned date of change
/api/v1/accounts	Organizations & organization invoice address data	Invoice addresses	To be defined1

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.

---

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. ↩ ↩² ↩³ ↩⁴ ↩⁵ ↩⁶ ↩⁷