Document apiReferenceHeader footers

headerFooters.list

List header/footer slot entries across sections.

read-onlyidempotent
doc.headerFooters.list(…)

Expected result

Returns a paginated DiscoveryOutput of HeaderFooterSlotEntry items.

Inputs

kind"header" | "footer"
sectionSectionAddress
Fields
kind"section"required
sectionIdstringrequired
limitinteger
offsetinteger

Result

Output fields
evaluatedRevisionstringrequired
totalintegerrequired
itemsobject[]required
pagePageInforequired
Fields
limitintegerrequired
offsetintegerrequired
returnedintegerrequired

Failures

Pre-apply throws

  • INVALID_INPUT
  • INVALID_TARGET

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