headerFooters.pageNumbers.get

Read where a section shows page numbers, their alignment, the first-page choice, and the section's number style and start. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

read-onlyidempotent
doc.headerFooters.pageNumbers.get(…)

Expected result

Returns the header and footer placements that show a PAGE field (empty when none), first-page visibility, the number format, and the start number or null when numbering continues.

Inputs

sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired

Result

Output fields
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
placementsobject[]required
showOnFirstPagebooleanrequired
titlePagebooleanrequired
format"decimal" | "lowerLetter" | "upperLetter" | "lowerRoman" | "upperRoman" | "numberInDash" | "hebrew1" | "hebrew2"required
startinteger | nullrequired
Variant 1

No fields.

Variant 2

No fields.

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET
  • INVALID_INPUT
1 more codes
  • 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