Document apiReferenceComments

comments.get

Retrieve a single comment thread by ID.

read-onlyidempotent
doc.comments.get(…)

Expected result

Returns a CommentInfo object with the comment text, author, date, and thread metadata.

Inputs

commentIdstringrequired

Result

Output fields
addressCommentAddressrequired
Fields
kind"entity"required
entityType"comment"required
entityIdstringrequired
commentIdstringrequired
externalIdstring

Caller-owned durable integration id, distinct from the Word-compatible commentId.

metadataobject

Caller-owned JSON metadata persisted with the comment.

importedIdstring
rawOoxmlIdstring

Durable raw OOXML source identity: the comment's w:id exactly as it appears in comments.xml. Surfaced for every catalog-backed comment, even when commentId already equals it on a clean import. Omitted for synthetic comments that never had a comments.xml carrier.

rawOoxmlOccurrenceIndexnumber

Zero-based source occurrence among comments that share the same rawOoxmlId in comments.xml. Present only for duplicate raw OOXML ids.

parentCommentIdstring
trackedChangeParentIdstring

SuperDoc logical tracked-change id when the comment anchor sits wholly inside exactly one active tracked change. Derived on read from the comment anchor index plus the tracked-change catalog.

trackedChangeThreadParentIdstring

SuperDoc logical tracked-change id whose review conversation this comment explicitly belongs to. Persisted provenance; never inferred from anchor overlap.

trackedChangeSide"inserted" | "deleted" | "source" | "destination"

Which side of the surrounding tracked change the comment anchor sits on. Pairs with `trackedChangeParentId`.

textstring
isInternalboolean
status"open" | "resolved"required
targetTextTarget
Fields
kind"text"required
segmentsTextSegment[]required
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
anchoredTextstring
createdTimenumber
creatorNamestring
creatorIdstring
creatorEmailstring
creatorImagestring
trackedChangeboolean
trackedChangeType"insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format"
trackedChangeDisplayTypestring | null
trackedChangeStoryStoryLocator | null
body / headerFooterSlot / headerFooterPart / footnote / endnote / textbox
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

No fields.

trackedChangeAnchorKeystring | null
trackedChangeTextstring | null
insertedTextstring | null
deletedTextstring | null
trackedChangeLinkCommentTrackedChangeLink | null
trackedChange
trackedChangetruerequired
trackedChangeIdstringrequired
trackedChangeType"insertion" | "deletion" | "replacement" | "formatting" | "move" | "structural" | "insert" | "delete" | "format"required
side"inserted" | "deleted" | "source" | "destination"
trackedChangeTextstring
insertedTextstring
deletedTextstring
Variant 2

No fields.

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