> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# lists.list

> List all list nodes in the document, optionally filtered by scope.

## Summary

List all list nodes in the document, optionally filtered by scope.

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

## Expected result

Returns a ListsListResult with an array of list item summaries and total count.

## Input fields

| Field | Type | Required | Description |
| - | - | - | - |
| `kind` | enum | no | `"ordered"`, `"bullet"` |
| `level` | integer | no | |
| `limit` | integer | no | |
| `offset` | integer | no | |
| `ordinal` | integer | no | |
| `within` | BlockNodeAddress | no | BlockNodeAddress |
| `within.kind` | `"block"` | no | Constant: `"block"` |
| `within.nodeId` | string | no | |
| `within.nodeType` | enum | no | `"paragraph"`, `"heading"`, `"listItem"`, `"table"`, `"tableRow"`, `"tableCell"`, `"tableOfContents"`, `"image"`, `"sdt"` |
| `within.story` | StoryLocator | no | StoryLocator |

### Example request

```json theme={null}
{
  "limit": 50,
  "within": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "paragraph",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}
```

## 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": {
        "kind": "block",
        "nodeId": "node-def456",
        "nodeType": "listItem",
        "story": {
          "kind": "story",
          "storyType": "body"
        }
      },
      "handle": {
        "ref": "handle:abc123",
        "refStability": "stable",
        "targetKind": "text"
      },
      "id": "id-001",
      "listId": "example",
      "marker": "1.",
      "ordinal": 1
    }
  ],
  "page": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  },
  "total": 1
}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`
* `INVALID_TARGET`
* `INVALID_INPUT`

## Non-applied failure codes

* None

## Raw schemas

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "kind": {
>       "enum": [
>         "ordered",
>         "bullet"
>       ]
>     },
>     "level": {
>       "type": "integer"
>     },
>     "limit": {
>       "type": "integer"
>     },
>     "offset": {
>       "type": "integer"
>     },
>     "ordinal": {
>       "type": "integer"
>     },
>     "within": {
>       "$ref": "#/$defs/BlockNodeAddress"
>     }
>   },
>   "type": "object"
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "evaluatedRevision": {
>       "type": "string"
>     },
>     "items": {
>       "items": {
>         "additionalProperties": false,
>         "properties": {
>           "address": {
>             "$ref": "#/$defs/ListItemAddress"
>           },
>           "handle": {
>             "$ref": "#/$defs/ResolvedHandle"
>           },
>           "id": {
>             "type": "string"
>           },
>           "kind": {
>             "enum": [
>               "ordered",
>               "bullet"
>             ]
>           },
>           "level": {
>             "type": "integer"
>           },
>           "listId": {
>             "type": "string"
>           },
>           "marker": {
>             "type": "string"
>           },
>           "ordinal": {
>             "type": "integer"
>           },
>           "path": {
>             "items": {
>               "type": "integer"
>             },
>             "type": "array"
>           },
>           "text": {
>             "type": "string"
>           }
>         },
>         "required": [
>           "id",
>           "handle",
>           "address",
>           "listId"
>         ],
>         "type": "object"
>       },
>       "type": "array"
>     },
>     "page": {
>       "$ref": "#/$defs/PageInfo"
>     },
>     "total": {
>       "minimum": 0,
>       "type": "integer"
>     }
>   },
>   "required": [
>     "evaluatedRevision",
>     "total",
>     "items",
>     "page"
>   ],
>   "type": "object"
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.