Document apiReferenceHyperlinks

hyperlinks.list

List all hyperlinks in the document, with optional filtering by href, anchor, or display text.

read-onlyidempotent
doc.hyperlinks.list(…)

Expected result

Returns a HyperlinksListResult with an array of hyperlink discovery items and pagination metadata.

Inputs

withinBlockNodeAddress
Fields
kind"block"required
nodeType"paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt"required
nodeIdstringrequired
storyStoryLocator

Story scope. Defaults to document body when omitted. Use {kind:'story', storyType:'body'} for body, or other storyType values for headers, footers, footnotes, endnotes.

body
kind"story"required
storyType"body"required
headerFooterSlot
kind"story"required
storyType"headerFooterSlot"required
sectionSectionAddressrequired
headerFooterKind"header" | "footer"required
variant"default" | "first" | "even"required
resolution"effective" | "explicit"
onWrite"materializeIfInherited" | "editResolvedPart" | "error"
headerFooterPart
kind"story"required
storyType"headerFooterPart"required
refIdstringrequired
footnote
kind"story"required
storyType"footnote"required
noteIdstringrequired
endnote
kind"story"required
storyType"endnote"required
noteIdstringrequired
textbox
kind"story"required
storyType"textbox"required
textboxIdstringrequired
hrefPatternstring
anchorstring
textPatternstring
limitinteger
offsetinteger

Result

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

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