Document apiReferenceLists

lists.getState

Read the numbering-aware list state for a paragraph (numId, ilvl, abstract reference, level format). Returns null when the target is not a list item. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

read-onlyidempotent
doc.lists.getState(…)

Expected result

Returns a ListsGetStateResult with `isListItem` plus numId/ilvl/abstract/numFmt metadata when present.

Inputs

targetparagraph | listItemrequired
paragraph
kind"block"required
nodeType"paragraph"required
nodeIdstringrequired
listItem
kind"block"required
nodeType"listItem"required
nodeIdstringrequired

Result

Output fields
true
successtruerequired
isListItembooleanrequired
numIdstring | null
ilvlintegerrequired
abstractNumIdstring | null
numFmtstring | null
lvlTextstring | null
seed"bullet" | "ordered" | null
false
successfalserequired
failureobjectrequired
Fields
code"TARGET_NOT_FOUND" | "CAPABILITY_UNAVAILABLE"required
messagestringrequired
detailsunknown

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

Non-applied receipt codes

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

Raw schemas

Open the generated JSON artifact for the exact input, output, success, and failure schemas represented by this contract version.

View raw JSON schemas