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

# toc.getEntry

> Retrieve details of a specific TC (table of contents entry) field.

## Summary

Retrieve details of a specific TC (table of contents entry) field.

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

## Expected result

Returns a TocEntryInfo object with the instruction, text, level, and switch configuration.

## Input fields

| Field | Type | Required | Description |
| - | - | - | - |
| `target` | object(kind="inline") | yes | |
| `target.kind` | `"inline"` | yes | Constant: `"inline"` |
| `target.nodeId` | string | yes | |
| `target.nodeType` | `"tableOfContentsEntry"` | yes | Constant: `"tableOfContentsEntry"` |

### Example request

```json theme={null}
{
  "target": {
    "kind": "inline",
    "nodeId": "node-def456",
    "nodeType": "tableOfContentsEntry"
  }
}
```

## Output fields

| Field | Type | Required | Description |
| - | - | - | - |
| `kind` | `"inline"` | yes | Constant: `"inline"` |
| `nodeType` | `"tableOfContentsEntry"` | yes | Constant: `"tableOfContentsEntry"` |
| `properties` | object | yes | |
| `properties.instruction` | string | yes | |
| `properties.level` | integer | yes | |
| `properties.omitPageNumber` | boolean | yes | |
| `properties.tableIdentifier` | string | no | |
| `properties.text` | string | yes | |

### Example response

```json theme={null}
{
  "kind": "inline",
  "nodeType": "tableOfContentsEntry",
  "properties": {
    "instruction": "example",
    "level": 1,
    "omitPageNumber": true,
    "tableIdentifier": "example",
    "text": "Hello, world."
  }
}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`

## Non-applied failure codes

* None

## Raw schemas

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "target": {
>       "additionalProperties": false,
>       "properties": {
>         "kind": {
>           "const": "inline"
>         },
>         "nodeId": {
>           "type": "string"
>         },
>         "nodeType": {
>           "const": "tableOfContentsEntry"
>         }
>       },
>       "required": [
>         "kind",
>         "nodeType",
>         "nodeId"
>       ],
>       "type": "object"
>     }
>   },
>   "required": [
>     "target"
>   ],
>   "type": "object"
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "kind": {
>       "const": "inline"
>     },
>     "nodeType": {
>       "const": "tableOfContentsEntry"
>     },
>     "properties": {
>       "additionalProperties": false,
>       "properties": {
>         "instruction": {
>           "type": "string"
>         },
>         "level": {
>           "type": "integer"
>         },
>         "omitPageNumber": {
>           "type": "boolean"
>         },
>         "tableIdentifier": {
>           "type": "string"
>         },
>         "text": {
>           "type": "string"
>         }
>       },
>       "required": [
>         "instruction",
>         "text",
>         "level",
>         "omitPageNumber"
>       ],
>       "type": "object"
>     }
>   },
>   "required": [
>     "nodeType",
>     "kind",
>     "properties"
>   ],
>   "type": "object"
> }
> ```


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