Document apiReferenceWatermarks

watermarks.list

List Word-compatible text and picture watermarks and their effective header scopes. Available on v2-backed sessions only; v1-backed sessions currently return `CAPABILITY_UNAVAILABLE`.

read-onlyidempotent
doc.watermarks.list(…)

Expected result

Returns a paginated WatermarksListResult with stable watermark identities and Word placement settings.

Inputs

targetdocument | headerFooterSlot
document
kind"document"required
headerFooterSlot
kind"headerFooterSlot"required
sectionSectionAddressrequired
Fields
kind"section"required
sectionIdstringrequired
headerFooterKind"header"required
variant"default" | "first" | "even"required
limitinteger
offsetinteger

Result

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

Failures

Pre-apply throws

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