Document apiReferenceFootnotes

footnotes.get

Get detailed information about a specific footnote or endnote.

read-onlyidempotent
doc.footnotes.get(…)

Expected result

Returns a FootnoteInfo object with the note's type, display number, and content.

Inputs

targetobjectrequired
Fields
kind"entity"required
entityType"footnote"required
noteIdstringrequired

Result

Output fields

No fields.

Failures

Pre-apply throws

  • 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