comments.list

List all comment threads in the document.

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

Summary

List all comment threads in the document.

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

Expected result

Returns a CommentsListResult with an array of comment threads and total count.

Input fields

Field	Type	Required	Description
includeResolved	boolean	no
limit	integer	no
offset	integer	no

Example request

{
  "includeResolved": true,
  "limit": 50
}

Output fields

Field	Type	Required	Description
evaluatedRevision	string	yes
items	object[]	yes
page	PageInfo	yes	PageInfo
page.limit	integer	yes
page.offset	integer	yes
page.returned	integer	yes
total	integer	yes

Example response

{
  "evaluatedRevision": "rev-001",
  "items": [
    {
      "address": {
        "entityId": "entity-789",
        "entityType": "comment",
        "kind": "entity"
      },
      "handle": {
        "ref": "handle:abc123",
        "refStability": "stable",
        "targetKind": "text"
      },
      "id": "id-001",
      "importedId": "imp-001",
      "parentCommentId": "comment-000",
      "status": "open"
    }
  ],
  "page": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  },
  "total": 1
}

Pre-apply throws

• INVALID_INPUT

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "includeResolved": {
      "type": "boolean"
    },
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    }
  },
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "evaluatedRevision": {
      "type": "string"
    },
    "items": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "address": {
            "$ref": "#/$defs/CommentAddress"
          },
          "anchoredText": {
            "type": "string"
          },
          "createdTime": {
            "type": "number"
          },
          "creatorEmail": {
            "type": "string"
          },
          "creatorName": {
            "type": "string"
          },
          "handle": {
            "$ref": "#/$defs/ResolvedHandle"
          },
          "id": {
            "type": "string"
          },
          "importedId": {
            "type": "string"
          },
          "isInternal": {
            "type": "boolean"
          },
          "parentCommentId": {
            "type": "string"
          },
          "status": {
            "enum": [
              "open",
              "resolved"
            ]
          },
          "target": {
            "$ref": "#/$defs/TextTarget"
          },
          "text": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "handle",
          "address",
          "status"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "page": {
      "$ref": "#/$defs/PageInfo"
    },
    "total": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "required": [
    "evaluatedRevision",
    "total",
    "items",
    "page"
  ],
  "type": "object"
}