Document apiReferenceFootnotes

footnotes.list

List all footnotes and endnotes in the document.

read-onlyidempotent
doc.footnotes.list(…)

Expected result

Returns a FootnotesListResult containing discovered footnotes with address and domain data.

Inputs

type"footnote" | "endnote"
limitinteger
offsetinteger

Result

Output fields

No fields.

Failures

Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

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