> ## Documentation Index
> Fetch the complete documentation index at: https://superdoc-caio-pizzol-docs-ai-core-preset.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# index.entries.get

> Get detailed information about a specific XE index entry.

## Summary

Get detailed information about a specific XE index entry.

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

## Expected result

Returns an IndexEntryInfo object with the entry's text, sub-entry, formatting, and instruction.

## Input fields

| Field                         | Type                  | Required | Description              |
| ----------------------------- | --------------------- | -------- | ------------------------ |
| `target`                      | object(kind="inline") | yes      |                          |
| `target.anchor`               | InlineAnchor          | yes      | InlineAnchor             |
| `target.anchor.end`           | Position              | yes      | Position                 |
| `target.anchor.end.blockId`   | string                | yes      |                          |
| `target.anchor.end.offset`    | integer               | yes      |                          |
| `target.anchor.start`         | Position              | yes      | Position                 |
| `target.anchor.start.blockId` | string                | yes      |                          |
| `target.anchor.start.offset`  | integer               | yes      |                          |
| `target.kind`                 | `"inline"`            | yes      | Constant: `"inline"`     |
| `target.nodeType`             | `"indexEntry"`        | yes      | Constant: `"indexEntry"` |

### Example request

```json theme={null}
{
  "target": {
    "anchor": {
      "end": {
        "blockId": "block-abc123",
        "offset": 0
      },
      "start": {
        "blockId": "block-abc123",
        "offset": 0
      }
    },
    "kind": "inline",
    "nodeType": "indexEntry"
  }
}
```

## Output fields

*No fields.*

### Example response

```json theme={null}
{}
```

## Pre-apply throws

* `TARGET_NOT_FOUND`
* `CAPABILITY_UNAVAILABLE`

## Non-applied failure codes

* None

## Raw schemas

<Accordion title="Raw input schema">
  ```json theme={null}
  {
    "additionalProperties": false,
    "properties": {
      "target": {
        "additionalProperties": false,
        "properties": {
          "anchor": {
            "$ref": "#/$defs/InlineAnchor"
          },
          "kind": {
            "const": "inline"
          },
          "nodeType": {
            "const": "indexEntry"
          }
        },
        "required": [
          "kind",
          "nodeType",
          "anchor"
        ],
        "type": "object"
      }
    },
    "required": [
      "target"
    ],
    "type": "object"
  }
  ```
</Accordion>

<Accordion title="Raw output schema">
  ```json theme={null}
  {
    "type": "object"
  }
  ```
</Accordion>