lists.get

Retrieve a specific list node by target.

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

Summary

Retrieve a specific list node by target.

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

Expected result

Returns a ListItemInfo object with the item kind, level, marker, and address.

Input fields

Field	Type	Required	Description
address	ListItemAddress	yes	ListItemAddress
address.kind	"block"	yes	Constant: "block"
address.nodeId	string	yes
address.nodeType	"listItem"	yes	Constant: "listItem"

Example request

{
  "address": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem"
  }
}

Output fields

Field	Type	Required	Description
address	ListItemAddress	yes	ListItemAddress
address.kind	"block"	yes	Constant: "block"
address.nodeId	string	yes
address.nodeType	"listItem"	yes	Constant: "listItem"
kind	enum	no	"ordered", "bullet"
level	integer	no
listId	string	yes
marker	string	no
ordinal	integer	no
path	integer[]	no
text	string	no

Example response

{
  "address": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem"
  },
  "listId": "example",
  "marker": "1.",
  "ordinal": 1
}

Pre-apply throws

• TARGET_NOT_FOUND

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/ListItemAddress"
    }
  },
  "required": [
    "address"
  ],
  "type": "object"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/ListItemAddress"
    },
    "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": [
    "address",
    "listId"
  ],
  "type": "object"
}