Elements
Read and mutate elements, the top-level editorial items in Kordiam. An element combines shared planning metadata with optional tasks, publications, and group assignments, and may represent a story, a planning entry, or a task-only assignment.
List elements
Lists elements, the top-level editorial items in Kordiam. An element combines shared planning metadata with optional tasks, publications, and group assignments, and may represent a story, a planning entry, or a task-only assignment. This endpoint uses cursor pagination only: page metadata and exact totals are not returned.
query Parameters
cursor^[A-Za-z0-9._~\-]*$Opaque cursor for keyset pagination. Mutually exclusive with page. Clients must not parse or construct it; pass the nextCursor value back unchanged. Current tokens use the shared v1.BASE64... format.
sizeRequested page size. Defaults to 20 and must not exceed 100.
dateFromPublication date range start (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd. Filters organization-visible publications.
dateToPublication date range end (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd. Filters organization-visible publications.
modificationDateFromModification date range start (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd.
modificationDateToModification date range end (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd.
creationDateFromCreation date range start (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd.
creationDateToCreation date range end (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd.
deadlineFromTask deadline range start (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd.
Requires userId. Narrows user task elements.
deadlineToTask deadline range end (inclusive). Accepts ISO 8601 instant or yyyy-MM-dd.
Requires userId. Narrows user task elements.
doneTask completion-state filter.
Requires userId. Narrows user task elements.
formatIdsTask format ID filter. Use comma-separated values, for example formatIds=501,502.
Requires userId. Narrows user task elements.
storyTypesSingle story type selector for group, platform, and task contexts. Use scheduled for dated publication stories or undated for undated/no-publication stories. Only one value is valid.
groupIdsFilter by group IDs. Selects group mode when used alone and can narrow task/platform modes. Use comma-separated values, for example groupIds=101,102.
platformIdFilter by platform ID.
withoutPublicationsReturn only elements without publications.
userIdFilter elements by tasks assigned to this user ID. Enables user task mode and allows deadlineFrom, deadlineTo, done, and formatIds. If deadline bounds are omitted, the deadline window defaults to today through today plus 14 days; tasks without a deadline are included by element modification date from today minus 6 months through today. Explicit deadline ranges must not exceed 366 days.
List elements › Responses
OK
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Always omitted for the element list endpoint. Exact totalElements and totalPages are unavailable; use hasMore and nextCursor.
sizeRequested cursor window size.
Create element
Creates a new story or event.
Create element › Request Body
confidentialIndicates whether the element is confidential.
Required on create. null is invalid.
Story or event attachments.
Omit, set null, or send [] to create without attachments.
Element custom field values.
Omit, set null, or send [] to create without element custom field values.
elementStatusIdElement status ID.
See Element Statuses for allowed values.
Omit or set null to use the default active element status, or No Status when the status feature is disabled or no default is configured.
Event start and end date/time.
Omit or set null to create without event dates.
Representation of the element in the external system.
Omit or set null to create without an external-system binding.
groupIdsElement group IDs.
See Groups for available groups.
Omit, set null, or send [] to create without group assignments.
Element location.
Omit or set null to create without location.
noteStory or event note.
Omit, set null, or send an empty string to leave it unset on create.
Element publications.
Omit, set null, or send [] to create without publications.
slugStory or event slug / short title.
Omit, set null, or send an empty string to leave it unset on create.
Element tasks.
Omit, set null, or send [] to create without tasks.
titleElement title.
Omit, set null, or send a blank value to apply the default title fallback.
When no source title is available, the API may store the no-title placeholder: [no title].
Create element › Responses
Element created; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Get element by ID
Returns one element, the top-level editorial item in Kordiam. The element response contains shared planning fields together with nested tasks and publications when they exist.
path Parameters
idGet element by ID › Responses
OK
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Replace element
Replaces the writable state of the addressed story or event.
path Parameters
idReplace element › Request Body
confidentialIndicates whether the story or event is confidential.
null is invalid.
Story or event attachments.
Omit or send [] to clear the collection. null is invalid.
Custom field values for the story or event.
Omit or send [] to clear them. null is invalid.
elementStatusIdStory or event status ID.
See Element Statuses for allowed values.
Omit or set null to use the default active element status, or No Status when the status feature is disabled or no default is configured.
Event start and end date/time.
Omit or set null to clear it.
Representation of the story or event in the external system.
Omit or set null to clear it.
groupIdsGroup IDs for the story or event.
See Groups for available groups.
Omit or send [] to clear the collection. null is invalid.
Story or event location.
Omit or set null to clear it.
noteStory or event note.
Omit, set null, or send an empty string to clear it.
Publication assignments for the story or event.
Omit or send [] to delete all publication assignments. null is invalid.
slugStory or event slug / short title.
Omit, set null, or send an empty string to clear it.
Tasks assigned to the story or event.
Omit or send [] to delete all tasks. null is invalid.
titleStory or event title.
Omit, set null, or send a blank value to apply the default title fallback.
When no source title is available, the API may store the no-title placeholder: [no title].
Replace element › Responses
Element replaced; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Update element
Partially updates the writable state of the addressed story or event.
path Parameters
idUpdate element › Request Body
Story or event attachments.
Omit to leave it unchanged. Send [] to clear the collection. null is invalid.
confidentialIndicates whether the story or event is confidential.
Omit to leave it unchanged. null is invalid.
Custom field patch instructions attached directly to this story or event.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
elementStatusIdStory or event status ID.
See Element Statuses for allowed values.
Omit to leave it unchanged. null is invalid; send No Status to clear it.
Story or event start and end date/time.
Omit to leave it unchanged. Set null to clear it.
Representation of the story or event in the external system.
Omit to leave it unchanged. Set null to clear it.
groupIdsGroups assigned to this story or event.
See Groups for available groups.
Omit to leave it unchanged. Send [] to clear the collection. null is invalid.
Story or event location.
Omit to leave it unchanged. Set null to clear it.
noteStory or event note.
Omit to leave it unchanged. Set null or send an empty string to clear it.
Publication patch instructions attached to this story or event.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
slugStory or event slug / short title.
Omit to leave it unchanged. Set null or send an empty string to clear it.
Task patch instructions attached to this story or event.
Omit to leave it unchanged. Send [] as an empty instruction list. null is invalid.
titleStory or event title.
Omit to leave it unchanged. Set null or send a blank value to apply the default title fallback.
When no source title is available, the API may store the no-title placeholder: [no title].
Update element › Responses
Element updated; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.
Update element custom fields
Partially updates custom fields attached directly to the addressed story or event.
path Parameters
idUpdate element custom fields › Request Body
Custom field patch instructions.
Send [] as an empty instruction list. null is invalid.
Update element custom fields › Responses
Element custom fields updated; current element snapshot returned
Element attachments.
confidentialIndicates whether the element is confidential.
creationTimeCreation date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
Creator of the element.
Element custom field values.
Last editor of the element.
Status for the entire element.
Event start and end date/time.
Convenience projection of the first active external binding in the current organization scope.
Use GET /api/v2/elements/{id}/external-elements for the complete binding list.
Groups selected for the element.
idElement ID.
Element location.
Element master group.
modificationDateLast modification date in UTC using ISO-8601 format (yyyy-MM-dd'T'HH:mm:ss'Z').
noteElement note.
Element publications.
slugElement slug / short title.
Element tasks.
titleElement description.
urlURL to open the element in Kordiam.
versionElement version.