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

​
Summary

  • 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

​
Input fields

FieldTypeRequiredDescription
addressListItemAddressyesListItemAddress

​
Example request

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

​
Output fields

FieldTypeRequiredDescription
addressListItemAddressyesListItemAddress
kindenumno"ordered", "bullet"
levelintegerno
markerstringno
ordinalintegerno
pathinteger[]no
textstringno

​
Example response

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

​
Pre-apply throws

  • TARGET_NOT_FOUND

​
Non-applied failure codes

  • None

​
Raw schemas

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

{
  "additionalProperties": false,
  "properties": {
    "address": {
      "$ref": "#/$defs/ListItemAddress"
    },
    "kind": {
      "enum": [
        "ordered",
        "bullet"
      ]
    },
    "level": {
      "type": "integer"
    },
    "marker": {
      "type": "string"
    },
    "ordinal": {
      "type": "integer"
    },
    "path": {
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "address"
  ],
  "type": "object"
}