Release Notes
Changelog
All notable changes to the Kordiam API are documented on this page, newest first. Entries affect API v2 unless tagged otherwise. For how versioning works, see the Versioning guide.
Entries are grouped as:
- Added - new endpoints, fields, or capabilities
- Changed - modifications to existing behavior
- Fixed - bug fixes to existing behavior
- Deprecated - features marked for future removal
- Removed - features that are no longer available
- Security - security-relevant fixes or changes
The first public release of the Kordiam v2 REST API. v2 keeps Kordiam's editorial concepts and rules, but makes the public contract explicit and consistent across resources.
Where to start
- New to the API? Begin with Getting Started.
- Moving from v1? See Migrating from v1 and Breaking Changes.
Added
- Elements - create, read, and update editorial stories and events (Resource Model)
- Element Tasks - manage work assignments within an element
- Element Publications - manage publications, including scheduling and publishing
- Task-publication linking - explicit links between tasks and publications (guide)
- Custom Fields - extensible fields on elements, tasks, and publications (guide)
- Configuration resources - Groups, Platforms, Categories, and Types, plus read-only Statuses and Task Formats (guide)
- People and scheduling - Users, Absences, and Shifts (guide)
- OAuth2 authentication - client-credentials token issuance with bearer tokens (guide)
- Pagination - shared list response with offset and cursor modes where the endpoint exposes both; the element list is cursor-only (Querying Lists)
- OpenAPI 3.1 specification and this documentation site
Changedcompared with v1
The public contract is reshaped in v2. The differences that most often affect integrators:
- endpoints are versioned under
/api/v2 - errors use RFC 9457 Problem Details
POST,PUT,PATCH, andDELETEfollow documented write semantics- list endpoints share a pagination shape with offset and cursor modes where exposed; the element list is cursor-only
- scalar references use explicit field names such as
platformId,categoryId, andstatusId - task-publication links use explicit
assignedTaskRefsorassignedTaskIdsinstead of v1 positional assignment arrays
For the complete, resource-by-resource list, see Breaking Changes.
Last modified on