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, content, and inline body reference addresses in references. V2 returns an empty references array for an unreferenced note.

Inputs

targetobjectrequired
Fields
kind"entity"required
entityType"footnote"required
noteIdstringrequired
noteType"footnote" | "endnote"

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