Document apiReferenceTrack changes

trackChanges.get

Retrieve a single tracked change by SuperDoc logical id.

read-onlyidempotent
doc.trackChanges.get(…)

Expected result

Returns a TrackChangeInfo object with the logical id, semantic type/subtype, state, target, before/after snapshots, author/initials/email, date, revisionGroupId, splitFromId, replacement or move side metadata when applicable, story locator, excerpt, optional overlap metadata, and source provenance via `sourceIds` / `wordRevisionIds`. Structural whole-table changes surface subtypes such as `table-insert` and `table-delete`.

Inputs

idstringrequired
1 additional input field
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired

Result

Output fields
addressTrackedChangeAddressrequired
Fields
kind"entity"required
entityType"trackedChange"required
entityIdstringrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
idstringrequired
type"insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format"required
subtypestring
state"open" | "accepted" | "rejected"
targetobject | object | object
Variant 1
kind"text"required
addressTrackedChangeAddressrequired
Fields
kind"entity"required
entityType"trackedChange"required
entityIdstringrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
Variant 2
kind"replacement"required
addressTrackedChangeAddressrequired
Fields
kind"entity"required
entityType"trackedChange"required
entityIdstringrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
Variant 3
kind"formatting"required
addressTrackedChangeAddressrequired
Fields
kind"entity"required
entityType"trackedChange"required
entityIdstringrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
subtype"run" | "paragraph" | "list" | "table" | "row" | "cell" | "section"required
beforeobject
Fields
textstring

Visible text snapshot when the affected revision is text-shaped.

formattingobject
Fields
xmlstring

Raw OOXML for the property block on this side.

propertiesobject

Subtype-aware semantic property map for formatting revisions.

afterobject
Fields
textstring

Visible text snapshot when the affected revision is text-shaped.

formattingobject
Fields
xmlstring

Raw OOXML for the property block on this side.

propertiesobject

Subtype-aware semantic property map for formatting revisions.

sourceIdsobject

Canonical multi-side source provenance. Provenance metadata only; never the canonical SuperDoc tracked-change id.

Fields
wordIdInsertstring

Word `w:id` value from the insertion side of this logical change.

wordIdDeletestring

Word `w:id` value from the deletion side of this logical change.

wordIdOtherstring[]

Word `w:id` values from other wrappers (for example moveFrom/moveTo).

rsidsstring[]

Word revision-save ids (`w:rsidR` / `w:rsidDel`) seen on contributing wrappers.

wordRevisionIdsobject

Raw imported Word OOXML revision IDs (`w:id`) from the source document when available. This is provenance metadata, not the canonical SuperDoc tracked-change ID. Replacements may include both `insert` and `delete` IDs.

Fields
insertstring

Raw imported Word OOXML revision ID (`w:id`) from a `<w:ins>` element when this logical change includes an insertion.

deletestring

Raw imported Word OOXML revision ID (`w:id`) from a `<w:del>` element when this logical change includes a deletion.

formatstring

Raw imported Word OOXML revision ID (`w:id`) from a `<w:rPrChange>` element when this logical change includes a formatting revision.

revisionGroupIdstring
splitFromIdstring | null
Variant 1

No fields.

Variant 2

No fields.

replacementobject
Fields
insertedobject | nullrequired
id
idstringrequired

Stable SuperDoc-internal side id.

excerptstringrequired

Visible text excerpt on this side.

wordIdstring

Raw Word `w:id` for this side, when known.

Variant 2

No fields.

deletedobject | nullrequired
id
idstringrequired

Stable SuperDoc-internal side id.

excerptstringrequired

Visible text excerpt on this side.

wordIdstring

Raw Word `w:id` for this side, when known.

Variant 2

No fields.

authorstring
authorEmailstring
authorImagestring
initialsstring
datestring
storyLocatorStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
sourcePlatform"word" | "google-docs" | "superdoc" | "unknown"
grouping"standalone" | "replacement-pair" | "unknown"
pairedWithChangeIdstring | null
Variant 1

No fields.

Variant 2

No fields.

insertedTextstring | null
Variant 1

No fields.

Variant 2

No fields.

deletedTextstring | null
Variant 1

No fields.

Variant 2

No fields.

formattingDeltaSummarystring | null

Human-readable formatting delta summary for formatting changes; null otherwise.

Variant 1

No fields.

Variant 2

No fields.

listDeltasobject[]

Structured per-member list semantic deltas for tracked list formatting changes (spec TC-LIST-003/004); absent for non-list changes.

listDeltaSummaryobject
Fields
uniformKind"list-add" | "list-remove" | "list-level" | "list-style" | "list-restart" | "indent" | "other-format" | nullrequired

The single delta kind shared by every member, or null for mixed groups.

Variant 1

No fields.

Variant 2

No fields.

countsobjectrequired

Non-zero member counts per delta kind.

Fields
list-addnumber
list-removenumber
list-levelnumber
list-stylenumber
list-restartnumber
indentnumber
other-formatnumber
targetIsListItemboolean

For paragraph-mark structural changes: whether the target paragraph is a direct-numbered list item.

listActionKind"merge-items"

Stable presentation fact on the merge-owner deletion change (spec TC-LIST-005).

origin"word" | "google-docs" | "superdoc" | "unknown"
importedboolean
canonicalizationKind"single-word-revision" | "paired-word-revision" | "generated-runtime-id" | "unknown"
addressKind"entity" | "story-entity" | "unknown"
resolvableByIdboolean
excerptstring
overlapobject
Fields
visualLayersobject[]

Ordered overlap layers, with the parent surface first and child layers after it.

preferredContextTargetIdstring

Preferred child tracked-change id for context-menu/comment targeting.

preferredContextTargetobject
Fields
idstringrequired

SuperDoc logical tracked-change id for this overlap layer.

type"insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format"required

Canonical broad tracked-change type for this layer.

relationship"parent" | "child" | "standalone"required
relationship"parent" | "child" | "standalone"
parentIdstring

Parent logical tracked-change id when this change is an overlap child.

customAttributesobject[]

Unknown extension attributes in document order; exact duplicates are removed and conflicting values are retained.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas