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

# headerFooters.list

> List header/footer slot entries across sections.

## Summary

List header/footer slot entries across sections.

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

## Expected result

Returns a paginated DiscoveryOutput of HeaderFooterSlotEntry items.

## Input fields

| Field | Type | Required | Description |
| - | - | - | - |
| `kind` | enum | no | `"header"`, `"footer"` |
| `limit` | integer | no | |
| `offset` | integer | no | |
| `section` | SectionAddress | no | SectionAddress |
| `section.kind` | `"section"` | no | Constant: `"section"` |
| `section.sectionId` | string | no | |

### Example request

```json theme={null}
{
  "kind": "header",
  "section": {
    "kind": "section",
    "sectionId": "example"
  }
}
```

## Output fields

| Field | Type | Required | Description |
| - | - | - | - |
| `evaluatedRevision` | string | yes | |
| `items` | object\[] | yes | |
| `page` | PageInfo | yes | PageInfo |
| `page.limit` | integer | yes | |
| `page.offset` | integer | yes | |
| `page.returned` | integer | yes | |
| `total` | integer | yes | |

### Example response

```json theme={null}
{
  "evaluatedRevision": "rev-001",
  "items": [
    {
      "handle": {
        "ref": "handle:abc123",
        "refStability": "stable",
        "targetKind": "text"
      },
      "id": "id-001",
      "isExplicit": true,
      "kind": "header",
      "refId": null,
      "section": {
        "kind": "section",
        "sectionId": "example"
      },
      "sectionIndex": 1,
      "variant": "default"
    }
  ],
  "page": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  },
  "total": 1
}
```

## Pre-apply throws

* `INVALID_INPUT`
* `INVALID_TARGET`

## Non-applied failure codes

* None

## Raw schemas

> [accordion] Raw input schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "kind": {
>       "enum": [
>         "header",
>         "footer"
>       ]
>     },
>     "limit": {
>       "minimum": 1,
>       "type": "integer"
>     },
>     "offset": {
>       "minimum": 0,
>       "type": "integer"
>     },
>     "section": {
>       "$ref": "#/$defs/SectionAddress"
>     }
>   },
>   "type": "object"
> }
> ```

> [accordion] Raw output schema
>
> ```json theme={null}
> {
>   "additionalProperties": false,
>   "properties": {
>     "evaluatedRevision": {
>       "type": "string"
>     },
>     "items": {
>       "items": {
>         "additionalProperties": false,
>         "properties": {
>           "handle": {
>             "$ref": "#/$defs/ResolvedHandle"
>           },
>           "id": {
>             "type": "string"
>           },
>           "isExplicit": {
>             "type": "boolean"
>           },
>           "kind": {
>             "enum": [
>               "header",
>               "footer"
>             ]
>           },
>           "refId": {
>             "type": [
>               "string",
>               "null"
>             ]
>           },
>           "section": {
>             "$ref": "#/$defs/SectionAddress"
>           },
>           "sectionIndex": {
>             "minimum": 0,
>             "type": "integer"
>           },
>           "variant": {
>             "enum": [
>               "default",
>               "first",
>               "even"
>             ]
>           }
>         },
>         "required": [
>           "id",
>           "handle",
>           "section",
>           "sectionIndex",
>           "kind",
>           "variant",
>           "isExplicit"
>         ],
>         "type": "object"
>       },
>       "type": "array"
>     },
>     "page": {
>       "$ref": "#/$defs/PageInfo"
>     },
>     "total": {
>       "minimum": 0,
>       "type": "integer"
>     }
>   },
>   "required": [
>     "evaluatedRevision",
>     "total",
>     "items",
>     "page"
>   ],
>   "type": "object"
> }
> ```


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