> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# comments.list

> List all comment threads in the document.

## 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

```json theme={null}
{
  "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

```json theme={null}
{
  "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

<Accordion title="Raw input schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "includeResolved": {
        "description": "When true, includes resolved comments in results. Default: false.",
        "type": "boolean"
      },
      "limit": {
        "description": "Maximum number of comments to return.",
        "type": "integer"
      },
      "offset": {
        "description": "Number of comments to skip for pagination.",
        "type": "integer"
      }
    },
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw output schema">
  ```json theme={null}
  {
    "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"
            },
            "deletedText": {
              "type": [
                "string",
                "null"
              ]
            },
            "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"
            },
            "trackedChange": {
              "type": "boolean"
            },
            "trackedChangeAnchorKey": {
              "type": [
                "string",
                "null"
              ]
            },
            "trackedChangeDisplayType": {
              "type": [
                "string",
                "null"
              ]
            },
            "trackedChangeLink": {
              "oneOf": [
                {
                  "$ref": "#/$defs/CommentTrackedChangeLink"
                },
                {
                  "type": "null"
                }
              ]
            },
            "trackedChangeStory": {
              "oneOf": [
                {
                  "$ref": "#/$defs/StoryLocator"
                },
                {
                  "type": "null"
                }
              ]
            },
            "trackedChangeText": {
              "type": [
                "string",
                "null"
              ]
            },
            "trackedChangeType": {
              "enum": [
                "insert",
                "delete",
                "replacement",
                "format"
              ]
            }
          },
          "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"
  }
  ```
</Accordion>