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

ā€‹
Summary

List all footnotes and endnotes in the document.
  • Operation ID: footnotes.list
  • API member path: editor.doc.footnotes.list(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

ā€‹
Expected result

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

ā€‹
Input fields

FieldTypeRequiredDescription
limitintegerno
offsetintegerno
typeenumno"footnote", "endnote"

ā€‹
Example request

{
  "limit": 50,
  "type": "footnote"
}

ā€‹
Output fields

No fields.

ā€‹
Example response

{}

ā€‹
Pre-apply throws

  • CAPABILITY_UNAVAILABLE
  • INVALID_INPUT

ā€‹
Non-applied failure codes

  • None

ā€‹
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "limit": {
      "type": "integer"
    },
    "offset": {
      "type": "integer"
    },
    "type": {
      "enum": [
        "footnote",
        "endnote"
      ]
    }
  },
  "type": "object"
}

{
  "type": "object"
}