Document apiReferenceHyperlinks

hyperlinks.get

Retrieve details of a specific hyperlink by its inline address.

read-onlyidempotent
doc.hyperlinks.get(…)

Expected result

Returns a HyperlinkInfo object with the address, destination properties, and display text.

Inputs

targetobjectrequired
Fields
kind"inline"required
nodeType"hyperlink"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
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

Result

Output fields
addressobjectrequired
Fields
kind"inline"required
nodeType"hyperlink"required
anchorInlineAnchorrequired
Fields
startPositionrequired
endPositionrequired
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
propertiesobjectrequired
Fields
hrefstring
anchorstring
docLocationstring
tooltipstring
targetstring
relstring

Browser relationship tokens for the current editing session. Not restored from DOCX.

textstring

Failures

Pre-apply throws

  • TARGET_NOT_FOUND
  • INVALID_TARGET

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