getNode

Retrieve a single node by target position.

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

Summary

Retrieve a single node by target position.

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

Expected result

Returns a NodeInfo object with the node type, address, content, and typed properties.

Input fields

Variant 1 (kind=“block”)

Field	Type	Required	Description
kind	"block"	yes	Constant: "block"
nodeId	string	yes
nodeType	enum	yes	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt"

Variant 2 (kind=“inline”)

Field	Type	Required	Description
anchor	InlineAnchor	yes	InlineAnchor
anchor.end	Position	yes	Position
anchor.end.blockId	string	yes
anchor.end.offset	integer	yes
anchor.start	Position	yes	Position
anchor.start.blockId	string	yes
anchor.start.offset	integer	yes
kind	"inline"	yes	Constant: "inline"
nodeType	enum	yes	"run", "bookmark", "comment", "hyperlink", "sdt", "image", "footnoteRef", "tab", "lineBreak"

Example request

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

Output fields

Field	Type	Required	Description
bodyNodes	object[]	no
bodyText	string	no
kind	enum	yes	"block", "inline"
nodeType	enum	yes	"paragraph", "heading", "listItem", "table", "tableRow", "tableCell", "tableOfContents", "image", "sdt", "run", "bookmark", "comment", "hyperlink", "footnoteRef", "tab", "lineBreak"
nodes	object[]	no
properties	object	no
summary	object	no
summary.label	string	no
summary.text	string	no
text	string	no

Example response

{
  "kind": "block",
  "nodeType": "paragraph",
  "summary": {
    "label": "Paragraph 1",
    "text": "Hello, world."
  },
  "text": "Hello, world."
}

Pre-apply throws

• TARGET_NOT_FOUND

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "$ref": "#/$defs/NodeAddress"
}

Raw output schema

{
  "additionalProperties": false,
  "properties": {
    "bodyNodes": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "bodyText": {
      "type": "string"
    },
    "kind": {
      "enum": [
        "block",
        "inline"
      ]
    },
    "nodes": {
      "items": {
        "type": "object"
      },
      "type": "array"
    },
    "nodeType": {
      "enum": [
        "paragraph",
        "heading",
        "listItem",
        "table",
        "tableRow",
        "tableCell",
        "tableOfContents",
        "image",
        "sdt",
        "run",
        "bookmark",
        "comment",
        "hyperlink",
        "footnoteRef",
        "tab",
        "lineBreak"
      ]
    },
    "properties": {
      "type": "object"
    },
    "summary": {
      "additionalProperties": false,
      "properties": {
        "label": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "type": "object"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "nodeType",
    "kind"
  ],
  "type": "object"
}