# 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.



- Member path: `doc.styles.getCatalog(…)`
- Mutates document: no
- Idempotency: `idempotent`
- Supports tracked mode: no
- Supports dry run: no

## 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).

## Input schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {},
  "type": "object",
  "properties": {
    "view": {
      "enum": [
        "quickGallery",
        "recommended",
        "currentDocument",
        "all",
        "inUse"
      ]
    },
    "types": {
      "type": "array",
      "items": {
        "enum": [
          "paragraph",
          "character",
          "linked",
          "table",
          "numbering"
        ]
      }
    },
    "includeHidden": {
      "type": "boolean"
    },
    "includeLatent": {
      "type": "boolean"
    },
    "includeUsage": {
      "type": "boolean"
    },
    "includePreview": {
      "type": "boolean"
    },
    "includeDiagnostics": {
      "type": "boolean"
    }
  },
  "additionalProperties": false
}
```

## Output schema

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$defs": {},
  "type": "object",
  "properties": {
    "version": {
      "const": "style-catalog/v1"
    },
    "revision": {
      "type": [
        "string",
        "null"
      ]
    },
    "view": {
      "enum": [
        "quickGallery",
        "recommended",
        "currentDocument",
        "all",
        "inUse"
      ]
    },
    "defaults": {
      "type": "object",
      "properties": {
        "paragraphStyleId": {
          "type": [
            "string",
            "null"
          ]
        },
        "characterStyleId": {
          "type": [
            "string",
            "null"
          ]
        },
        "tableStyleId": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "paragraphStyleId",
        "characterStyleId",
        "tableStyleId"
      ]
    },
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "aliases": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "type": {
            "enum": [
              "paragraph",
              "character",
              "linked",
              "table",
              "numbering",
              "unknown"
            ]
          },
          "custom": {
            "type": "boolean"
          },
          "builtin": {
            "type": "boolean"
          },
          "default": {
            "type": "boolean"
          },
          "basedOn": {
            "type": [
              "string",
              "null"
            ]
          },
          "next": {
            "type": [
              "string",
              "null"
            ]
          },
          "link": {
            "type": [
              "string",
              "null"
            ]
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ]
          },
          "qFormat": {
            "type": "boolean"
          },
          "hidden": {
            "type": "boolean"
          },
          "semiHidden": {
            "type": "boolean"
          },
          "unhideWhenUsed": {
            "type": "boolean"
          },
          "locked": {
            "type": "boolean"
          },
          "provenance": {
            "enum": [
              "authored",
              "default-floor",
              "latent"
            ]
          },
          "visibility": {
            "type": "object",
            "properties": {
              "quickGallery": {
                "type": "boolean"
              },
              "recommended": {
                "type": "boolean"
              },
              "all": {
                "type": "boolean"
              },
              "effectivelyHidden": {
                "type": "boolean"
              }
            },
            "additionalProperties": false,
            "required": [
              "quickGallery",
              "recommended",
              "all",
              "effectivelyHidden"
            ]
          },
          "usage": {
            "type": "object",
            "properties": {
              "used": {
                "type": "boolean"
              },
              "paragraphCount": {
                "type": "integer",
                "minimum": 0
              },
              "runCount": {
                "type": "integer",
                "minimum": 0
              },
              "tableCount": {
                "type": "integer",
                "minimum": 0
              },
              "numberingCount": {
                "type": "integer",
                "minimum": 0
              }
            },
            "additionalProperties": false,
            "required": [
              "used"
            ]
          },
          "preview": {
            "type": "object",
            "properties": {
              "available": {
                "type": "boolean"
              },
              "css": {
                "type": "object"
              },
              "unsupportedReason": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "available"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "aliases",
          "type",
          "custom",
          "builtin",
          "default",
          "basedOn",
          "next",
          "link",
          "priority",
          "qFormat",
          "hidden",
          "semiHidden",
          "unhideWhenUsed",
          "locked",
          "provenance",
          "visibility"
        ]
      }
    },
    "styles": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "aliases": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "type": {
            "enum": [
              "paragraph",
              "character",
              "linked",
              "table",
              "numbering",
              "unknown"
            ]
          },
          "custom": {
            "type": "boolean"
          },
          "builtin": {
            "type": "boolean"
          },
          "default": {
            "type": "boolean"
          },
          "basedOn": {
            "type": [
              "string",
              "null"
            ]
          },
          "next": {
            "type": [
              "string",
              "null"
            ]
          },
          "link": {
            "type": [
              "string",
              "null"
            ]
          },
          "priority": {
            "type": [
              "integer",
              "null"
            ]
          },
          "qFormat": {
            "type": "boolean"
          },
          "hidden": {
            "type": "boolean"
          },
          "semiHidden": {
            "type": "boolean"
          },
          "unhideWhenUsed": {
            "type": "boolean"
          },
          "locked": {
            "type": "boolean"
          },
          "provenance": {
            "enum": [
              "authored",
              "default-floor",
              "latent"
            ]
          },
          "visibility": {
            "type": "object",
            "properties": {
              "quickGallery": {
                "type": "boolean"
              },
              "recommended": {
                "type": "boolean"
              },
              "all": {
                "type": "boolean"
              },
              "effectivelyHidden": {
                "type": "boolean"
              }
            },
            "additionalProperties": false,
            "required": [
              "quickGallery",
              "recommended",
              "all",
              "effectivelyHidden"
            ]
          },
          "usage": {
            "type": "object",
            "properties": {
              "used": {
                "type": "boolean"
              },
              "paragraphCount": {
                "type": "integer",
                "minimum": 0
              },
              "runCount": {
                "type": "integer",
                "minimum": 0
              },
              "tableCount": {
                "type": "integer",
                "minimum": 0
              },
              "numberingCount": {
                "type": "integer",
                "minimum": 0
              }
            },
            "additionalProperties": false,
            "required": [
              "used"
            ]
          },
          "preview": {
            "type": "object",
            "properties": {
              "available": {
                "type": "boolean"
              },
              "css": {
                "type": "object"
              },
              "unsupportedReason": {
                "type": "string"
              }
            },
            "additionalProperties": false,
            "required": [
              "available"
            ]
          }
        },
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "aliases",
          "type",
          "custom",
          "builtin",
          "default",
          "basedOn",
          "next",
          "link",
          "priority",
          "qFormat",
          "hidden",
          "semiHidden",
          "unhideWhenUsed",
          "locked",
          "provenance",
          "visibility"
        ]
      }
    },
    "sourceStatus": {
      "type": "object",
      "properties": {
        "styles": {
          "enum": [
            "present",
            "missing",
            "malformed"
          ]
        },
        "settings": {
          "enum": [
            "present",
            "missing",
            "malformed"
          ]
        },
        "usage": {
          "enum": [
            "unsupported",
            "complete",
            "partial",
            "failed"
          ]
        },
        "preview": {
          "enum": [
            "unsupported",
            "available"
          ]
        },
        "view": {
          "enum": [
            "supported",
            "unsupported"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "styles",
        "settings",
        "usage",
        "preview",
        "view"
      ]
    },
    "diagnostics": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "severity": {
            "enum": [
              "info",
              "warning",
              "error"
            ]
          },
          "code": {
            "type": "string"
          },
          "part": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "additionalProperties": false,
        "required": [
          "severity",
          "code",
          "message"
        ]
      }
    }
  },
  "additionalProperties": false,
  "required": [
    "version",
    "revision",
    "view",
    "defaults",
    "items",
    "styles",
    "sourceStatus",
    "diagnostics"
  ]
}
```

## Pre-apply throws

- `INVALID_INPUT`
- `CAPABILITY_UNAVAILABLE`

## Non-applied receipt codes

- None