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

​
Summary

  • 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

​
Input fields

FieldTypeRequiredDescription
commentIdstringyes

​
Example request

{
  "commentId": "comment-001"
}

​
Output fields

FieldTypeRequiredDescription
addressCommentAddressyesCommentAddress
anchoredTextstringno
commentIdstringyes
createdTimenumberno
creatorEmailstringno
creatorNamestringno
importedIdstringno
isInternalbooleanno
parentCommentIdstringno
statusenumyes"open", "resolved"
targetTextTargetnoTextTarget
textstringno

​
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

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

{
  "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"
}