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
Added
catalogsproperty in Collection response: Added thecatalogsproperty to the Collection object returned by GET/collectionsand GET/collections/{id}endpoints. This property contains an array of catalogs in which the collection is present, including the catalogidandname.- The
catalogsproperty is an optional array that will be included in all collection responses from the Partner API - Each catalog object contains
id(UUID) andname(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}/collectionsand GET/platforms/{installation_id}/collectionsendpoints
- The
[1.1.2] - 2026-01-15
Added
collectionsproperty in Course response: Added thecollectionsproperty to the Course object returned by GET/coursesand GET/courses/{id}endpoints. This property contains an array of collections in which the course is present, including the collectionidandtitle.- The
collectionsproperty is an optional array that will be included in all course responses from the Partner API - Each collection object contains
id(UUID) andtitle(string) - This allows partners to see which collections contain each course without making additional API calls
- The
[1.1.1] - 2026-01-15
Added
catalogsproperty in Course response: Added thecatalogsproperty to the Course object returned by GET/coursesand GET/courses/{id}endpoints. This property contains an array of catalogs in which the course is present, including the catalogidandname.- The
catalogsproperty is an optional array that will be included in all course responses from the Partner API - Each catalog object contains
id(UUID) andname(string) - This allows partners to see which catalogs contain each course without making additional API calls
- The
[1.1.0] - 2026-01-15
Added
audioproperty inlanguages: Added theaudioproperty to thelanguagesobject of courses to list available audio languages in RFC1766 format. The property is available both for the main course and for courses indicated in thelanguage_equivalentarray.- The
audioproperty is an optional array of strings representing available audio languages for the course - The
audioproperty is also available within each element of thelanguage_equivalentarray for related courses - All languages (content, subtitles, audio) use RFC1766 format
- The
Changed
- API version updated from
1.0.0to1.1.0 - Renamed
language_settolanguage_equivalent: The propertylanguage_setin thelanguagesobject has been renamed tolanguage_equivalentfor 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_setmust be updated tolanguage_equivalent
Notes
- This is a minor version change that maintains backward compatibility for most fields
- The API path remains
/v1for compatibility - Existing clients will need to update references from
language_settolanguage_equivalent - Clients can now access audio language information for courses
[1.0.0] - 2026-01-01
Added
- Initial release of the Partner API
- Course management endpoints (create, read, update, delete)
- Catalog management endpoints
- Collection management endpoints
- Platform assignment and management
- Topic hierarchy management
- Series and episode management
- JWT-based authentication
- Complete OpenAPI documentation
- Postman collection for testing