comments.get - SuperDoc

Summary

Retrieve a single comment thread by ID.

Operation ID: comments.get
API member path: editor.doc.comments.get(...)
Mutates document: no
Idempotency: idempotent
Supports tracked mode: no
Supports dry run: no
Deterministic target resolution: yes

Expected result

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

Input fields

Field	Type	Required	Description
`commentId`	string	yes

Example request

{
  "commentId": "comment-001"
}

Output fields

Field	Type	Required	Description
`address`	CommentAddress	yes	CommentAddress
`address.entityId`	string	yes
`address.entityType`	`"comment"`	yes	Constant: `"comment"`
`address.kind`	`"entity"`	yes	Constant: `"entity"`
`anchoredText`	string	no
`commentId`	string	yes
`createdTime`	number	no
`creatorEmail`	string	no
`creatorName`	string	no
`deletedText`	string \| null	no
`importedId`	string	no
`insertedText`	string \| null	no
`isInternal`	boolean	no
`parentCommentId`	string	no
`status`	enum	yes	`"open"`, `"resolved"`
`target`	TextTarget	no	TextTarget
`target.kind`	`"text"`	no	Constant: `"text"`
`target.segments`	TextSegment[]	no
`target.story`	StoryLocator	no	StoryLocator
`text`	string	no
`trackedChange`	boolean	no
`trackedChangeAnchorKey`	string \| null	no
`trackedChangeDisplayType`	string \| null	no
`trackedChangeLink`	CommentTrackedChangeLink \| null	no	One of: CommentTrackedChangeLink, null
`trackedChangeParentId`	string	no
`trackedChangeSide`	enum	no	`"inserted"`, `"deleted"`, `"source"`, `"destination"`
`trackedChangeStory`	StoryLocator \| null	no	One of: StoryLocator, null
`trackedChangeText`	string \| null	no
`trackedChangeType`	enum	no	`"insertion"`, `"deletion"`, `"replacement"`, `"formatting"`, `"move"`, `"structural"`, `"insert"`, `"delete"`, `"format"`

Example response

{
  "address": {
    "entityId": "entity-789",
    "entityType": "comment",
    "kind": "entity"
  },
  "commentId": "comment-001",
  "importedId": "imp-001",
  "parentCommentId": "comment-000",
  "status": "open"
}

Pre-apply throws

TARGET_NOT_FOUND

Non-applied failure codes

None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "commentId": {
      "type": "string"
    }
  },
  "required": [
    "commentId"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/CommentAddress"
    },
    "anchoredText": {
      "type": "string"
    },
    "commentId": {
      "type": "string"
    },
    "createdTime": {
      "type": "number"
    },
    "creatorEmail": {
      "type": "string"
    },
    "creatorName": {
      "type": "string"
    },
    "deletedText": {
      "type": [
        "string",
        "null"
      ]
    },
    "importedId": {
      "type": "string"
    },
    "insertedText": {
      "type": [
        "string",
        "null"
      ]
    },
    "isInternal": {
      "type": "boolean"
    },
    "parentCommentId": {
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "resolved"
      ]
    },
    "target": {
      "$ref": "#/$defs/TextTarget"
    },
    "text": {
      "type": "string"
    },
    "trackedChange": {
      "type": "boolean"
    },
    "trackedChangeAnchorKey": {
      "type": [
        "string",
        "null"
      ]
    },
    "trackedChangeDisplayType": {
      "type": [
        "string",
        "null"
      ]
    },
    "trackedChangeLink": {
      "oneOf": [
        {
          "$ref": "#/$defs/CommentTrackedChangeLink"
        },
        {
          "type": "null"
        }
      ]
    },
    "trackedChangeParentId": {
      "description": "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.",
      "type": "string"
    },
    "trackedChangeSide": {
      "description": "Which side of the surrounding tracked change the comment anchor sits on. Pairs with `trackedChangeParentId`.",
      "enum": [
        "inserted",
        "deleted",
        "source",
        "destination"
      ]
    },
    "trackedChangeStory": {
      "oneOf": [
        {
          "$ref": "#/$defs/StoryLocator"
        },
        {
          "type": "null"
        }
      ]
    },
    "trackedChangeText": {
      "type": [
        "string",
        "null"
      ]
    },
    "trackedChangeType": {
      "enum": [
        "insertion",
        "deletion",
        "replacement",
        "formatting",
        "move",
        "structural",
        "insert",
        "delete",
        "format"
      ]
    }
  },
  "required": [
    "address",
    "commentId",
    "status"
  ],
  "type": "object"
}

​Summary

​Expected result

​Input fields

​Example request

​Output fields

​Example response

​Pre-apply throws

​Non-applied failure codes

​Raw schemas

Summary

Expected result

Input fields

Example request

Output fields

Example response

Pre-apply throws

Non-applied failure codes

Raw schemas