Document apiReferenceSections

sections.get

Retrieve full section information by section address.

read-onlyidempotent
doc.sections.get(…)

Expected result

Returns a SectionInfo object with full section properties including margins, columns, and header/footer refs.

Inputs

addressSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired

Result

Output fields
addressSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
indexintegerrequired
rangeobjectrequired
Fields
startParagraphIndexintegerrequired
endParagraphIndexintegerrequired
breakType"continuous" | "nextPage" | "evenPage" | "oddPage"
pageSetupobject
Fields
widthnumber
heightnumber
orientation"portrait" | "landscape"
paperSizestring
marginsobject
Fields
topnumber
rightnumber
bottomnumber
leftnumber
gutternumber
headerFooterMarginsobject
Fields
headernumber
footernumber
columnsobject
Fields
countinteger
gapnumber
equalWidthboolean
lineNumberingobject
Fields
enabledbooleanrequired
countByinteger
startinteger
distancenumber
restart"continuous" | "newPage" | "newSection"
pageNumberingobject
Fields
startinteger
format"decimal" | "lowerLetter" | "upperLetter" | "lowerRoman" | "upperRoman" | "numberInDash"
chapterStyleinteger
chapterSeparator"hyphen" | "period" | "colon" | "emDash" | "enDash"
titlePageboolean
oddEvenHeadersFootersboolean
verticalAlign"top" | "center" | "bottom" | "both"
sectionDirection"ltr" | "rtl"
headerRefsobject
Fields
defaultstring
firststring
evenstring
footerRefsobject
Fields
defaultstring
firststring
evenstring
pageBordersdisplay | offsetFrom | zOrder | top | right | bottom | left
display

No fields.

offsetFrom

No fields.

zOrder

No fields.

top

No fields.

right

No fields.

bottom

No fields.

left

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