Document apiReferenceStyles

styles.getCatalog

List the available styles as a normalized catalogue with stable IDs, display names, type, visibility, priority, provenance, and source diagnostics. Supports view (quickGallery/recommended/currentDocument/all/inUse), type filtering, hidden/latent inclusion, usage rollups, and UI-safe preview tokens. Distinct from DocumentInfo.styles, which is a usage summary.

read-onlyidempotent
doc.styles.getCatalog(…)

Expected result

Returns a StylesGetCatalogResult with the requested view, the full filtered style set, document defaults, per-source status, and diagnostics (including labeled fallbacks and unsupported-option notices).

Inputs

view"quickGallery" | "recommended" | "currentDocument" | "all" | "inUse"
types"paragraph" | "character" | "linked" | "table" | "numbering"[]
includeHiddenboolean
includeLatentboolean
includeUsageboolean
includePreviewboolean
includeDiagnosticsboolean

Result

Output fields
version"style-catalog/v1"required
revisionstring | nullrequired
view"quickGallery" | "recommended" | "currentDocument" | "all" | "inUse"required
defaultsobjectrequired
Fields
paragraphStyleIdstring | nullrequired
characterStyleIdstring | nullrequired
tableStyleIdstring | nullrequired
itemsobject[]required
stylesobject[]required
sourceStatusobjectrequired
Fields
styles"present" | "missing" | "malformed"required
settings"present" | "missing" | "malformed"required
usage"unsupported" | "complete" | "partial" | "failed"required
preview"unsupported" | "available"required
view"supported" | "unsupported"required
diagnosticsobject[]required

Failures

Pre-apply throws

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