Document apiReferenceHeader footers

headerFooters.get

Get a single header/footer slot entry by address.

read-onlyidempotent
doc.headerFooters.get(…)

Expected result

Returns a HeaderFooterSlotEntry for the targeted section slot.

Inputs

targetobjectrequired
Fields
kind"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required

Result

Output fields
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
sectionIndexintegerrequired
kind"header" | "footer"required
variant"default" | "first" | "even"required
refIdstring | null
isExplicitbooleanrequired

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • 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