> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superdoc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# lists.getStyle

> Read the effective reusable style of a list, including instance-level overrides. Returns a ListStyle that can be applied to other lists via lists.applyStyle.

## Summary

Read the effective reusable style of a list, including instance-level overrides. Returns a ListStyle that can be applied to other lists via lists.applyStyle.

* Operation ID: `lists.getStyle`
* API member path: `editor.doc.lists.getStyle(...)`
* Mutates document: `no`
* Idempotency: `idempotent`
* Supports tracked mode: `no`
* Supports dry run: `no`
* Deterministic target resolution: `yes`

## Expected result

Returns a ListsGetStyleResult containing the captured style.

## Input fields

| Field | Type | Required | Description |
| - | - | - | - |
| `levels` | integer\[] | no | |
| `target` | ListItemAddress | yes | ListItemAddress |
| `target.kind` | `"block"` | yes | Constant: `"block"` |
| `target.nodeId` | string | yes | |
| `target.nodeType` | `"listItem"` | yes | Constant: `"listItem"` |
| `target.story` | StoryLocator | no | StoryLocator |

### Example request

```json theme={null}
{
  "levels": [
    1
  ],
  "target": {
    "kind": "block",
    "nodeId": "node-def456",
    "nodeType": "listItem",
    "story": {
      "kind": "story",
      "storyType": "body"
    }
  }
}
```

## Output fields

### Variant 1 (success=true)

| Field | Type | Required | Description |
| - | - | - | - |
| `style` | object | yes | |
| `style.levels` | object\[] | yes | |
| `style.version` | `1` | yes | Constant: `1` |
| `success` | `true` | yes | Constant: `true` |

### Variant 2 (success=false)

| Field | Type | Required | Description |
| - | - | - | - |
| `failure` | object | yes | |
| `failure.code` | enum | yes | `"INVALID_TARGET"`, `"INVALID_INPUT"`, `"LEVEL_OUT_OF_RANGE"` |
| `failure.details` | any | no | |
| `failure.message` | string | yes | |
| `success` | `false` | yes | Constant: `false` |

### Example response

```json theme={null}
{
  "style": {
    "levels": [
      {
        "level": 1,
        "lvlText": "example",
        "numFmt": "example"
      }
    ],
    "version": 1
  },
  "success": true
}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`
* `INVALID_TARGET`
* `INVALID_INPUT`

## Non-applied failure codes

* `INVALID_TARGET`
* `INVALID_INPUT`
* `LEVEL_OUT_OF_RANGE`

## Raw schemas

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "levels": {
>       "items": {
>         "maximum": 8,
>         "minimum": 0,
>         "type": "integer"
>       },
>       "type": "array"
>     },
>     "target": {
>       "$ref": "#/$defs/ListItemAddress"
>     }
>   },
>   "required": [
>     "target"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "oneOf": [
>     {
>       "additionalProperties": false,
>       "properties": {
>         "style": {
>           "additionalProperties": false,
>           "properties": {
>             "levels": {
>               "items": {
>                 "additionalProperties": false,
>                 "properties": {
>                   "alignment": {
>                     "enum": [
>                       "left",
>                       "center",
>                       "right"
>                     ]
>                   },
>                   "indents": {
>                     "additionalProperties": false,
>                     "properties": {
>                       "firstLine": {
>                         "type": "integer"
>                       },
>                       "hanging": {
>                         "type": "integer"
>                       },
>                       "left": {
>                         "type": "integer"
>                       }
>                     },
>                     "type": "object"
>                   },
>                   "level": {
>                     "maximum": 8,
>                     "minimum": 0,
>                     "type": "integer"
>                   },
>                   "lvlText": {
>                     "type": "string"
>                   },
>                   "markerFont": {
>                     "type": "string"
>                   },
>                   "numFmt": {
>                     "type": "string"
>                   },
>                   "pictureBulletId": {
>                     "type": "integer"
>                   },
>                   "start": {
>                     "type": "integer"
>                   },
>                   "tabStopAt": {
>                     "type": [
>                       "integer",
>                       "null"
>                     ]
>                   },
>                   "trailingCharacter": {
>                     "enum": [
>                       "tab",
>                       "space",
>                       "nothing"
>                     ]
>                   }
>                 },
>                 "required": [
>                   "level"
>                 ],
>                 "type": "object"
>               },
>               "type": "array"
>             },
>             "version": {
>               "const": 1
>             }
>           },
>           "required": [
>             "version",
>             "levels"
>           ],
>           "type": "object"
>         },
>         "success": {
>           "const": true
>         }
>       },
>       "required": [
>         "success",
>         "style"
>       ],
>       "type": "object"
>     },
>     {
>       "additionalProperties": false,
>       "properties": {
>         "failure": {
>           "additionalProperties": false,
>           "properties": {
>             "code": {
>               "enum": [
>                 "INVALID_TARGET",
>                 "INVALID_INPUT",
>                 "LEVEL_OUT_OF_RANGE"
>               ]
>             },
>             "details": {},
>             "message": {
>               "type": "string"
>             }
>           },
>           "required": [
>             "code",
>             "message"
>           ],
>           "type": "object"
>         },
>         "success": {
>           "const": false
>         }
>       },
>       "required": [
>         "success",
>         "failure"
>       ],
>       "type": "object"
>     }
>   ]
> }
> ```

> [accordion] Raw success schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "style": {
>       "additionalProperties": false,
>       "properties": {
>         "levels": {
>           "items": {
>             "additionalProperties": false,
>             "properties": {
>               "alignment": {
>                 "enum": [
>                   "left",
>                   "center",
>                   "right"
>                 ]
>               },
>               "indents": {
>                 "additionalProperties": false,
>                 "properties": {
>                   "firstLine": {
>                     "type": "integer"
>                   },
>                   "hanging": {
>                     "type": "integer"
>                   },
>                   "left": {
>                     "type": "integer"
>                   }
>                 },
>                 "type": "object"
>               },
>               "level": {
>                 "maximum": 8,
>                 "minimum": 0,
>                 "type": "integer"
>               },
>               "lvlText": {
>                 "type": "string"
>               },
>               "markerFont": {
>                 "type": "string"
>               },
>               "numFmt": {
>                 "type": "string"
>               },
>               "pictureBulletId": {
>                 "type": "integer"
>               },
>               "start": {
>                 "type": "integer"
>               },
>               "tabStopAt": {
>                 "type": [
>                   "integer",
>                   "null"
>                 ]
>               },
>               "trailingCharacter": {
>                 "enum": [
>                   "tab",
>                   "space",
>                   "nothing"
>                 ]
>               }
>             },
>             "required": [
>               "level"
>             ],
>             "type": "object"
>           },
>           "type": "array"
>         },
>         "version": {
>           "const": 1
>         }
>       },
>       "required": [
>         "version",
>         "levels"
>       ],
>       "type": "object"
>     },
>     "success": {
>       "const": true
>     }
>   },
>   "required": [
>     "success",
>     "style"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw failure schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "failure": {
>       "additionalProperties": false,
>       "properties": {
>         "code": {
>           "enum": [
>             "INVALID_TARGET",
>             "INVALID_INPUT",
>             "LEVEL_OUT_OF_RANGE"
>           ]
>         },
>         "details": {},
>         "message": {
>           "type": "string"
>         }
>       },
>       "required": [
>         "code",
>         "message"
>       ],
>       "type": "object"
>     },
>     "success": {
>       "const": false
>     }
>   },
>   "required": [
>     "success",
>     "failure"
>   ],
>   "type": "object"
> }
> ```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.