comments.get

Retrieve a single comment thread by ID.

Alpha: Document API is currently alpha and subject to breaking changes.

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
importedId	string	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
text	string	no

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"
    },
    "importedId": {
      "type": "string"
    },
    "isInternal": {
      "type": "boolean"
    },
    "parentCommentId": {
      "type": "string"
    },
    "status": {
      "enum": [
        "open",
        "resolved"
      ]
    },
    "target": {
      "$ref": "#/$defs/TextTarget"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "address",
    "commentId",
    "status"
  ],
  "type": "object"
}