Changelog

All notable changes to the Partner API will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.1.3] - 2026-01-16

catalogs property in Collection response: Added the catalogs property to the Collection object returned by GET /collections and GET /collections/{id} endpoints. This property contains an array of catalogs in which the collection is present, including the catalog id and name.
- The catalogs property is an optional array that will be included in all collection responses from the Partner API
- Each catalog object contains id (UUID) and name (string)
- This allows partners to see which catalogs contain each collection without making additional API calls
- The property is also included in responses from GET /catalogs/{id}/collections and GET /platforms/{installation_id}/collections endpoints

collections property in Course response: Added the collections property to the Course object returned by GET /courses and GET /courses/{id} endpoints. This property contains an array of collections in which the course is present, including the collection id and title.
- The collections property is an optional array that will be included in all course responses from the Partner API
- Each collection object contains id (UUID) and title (string)
- This allows partners to see which collections contain each course without making additional API calls

catalogs property in Course response: Added the catalogs property to the Course object returned by GET /courses and GET /courses/{id} endpoints. This property contains an array of catalogs in which the course is present, including the catalog id and name.
- The catalogs property is an optional array that will be included in all course responses from the Partner API
- Each catalog object contains id (UUID) and name (string)
- This allows partners to see which catalogs contain each course without making additional API calls

audio property in languages: Added the audio property to the languages object of courses to list available audio languages in RFC1766 format. The property is available both for the main course and for courses indicated in the language_equivalent array.
- The audio property is an optional array of strings representing available audio languages for the course
- The audio property is also available within each element of the language_equivalent array for related courses
- All languages (content, subtitles, audio) use RFC1766 format

API version updated from 1.0.0 to 1.1.0
Renamed language_set to language_equivalent: The property language_set in the languages object has been renamed to language_equivalent for better clarity. This is a breaking change that requires client updates.
- The new property name better reflects that these are equivalent courses in different languages
- All existing references to language_set must be updated to language_equivalent

This is a minor version change that maintains backward compatibility for most fields
The API path remains /v1 for compatibility
Existing clients will need to update references from language_set to language_equivalent
Clients can now access audio language information for courses