Skip to main content
Alpha: Document API is currently alpha and subject to breaking changes.

​
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

FieldTypeRequiredDescription
kindenumno"header", "footer"
limitintegerno
offsetintegerno
sectionSectionAddressnoSectionAddress
section.kind"section"noConstant: "section"
section.sectionIdstringno

​
Example request

{
  "kind": "header",
  "section": {
    "kind": "section",
    "sectionId": "example"
  }
}

​
Output fields

FieldTypeRequiredDescription
evaluatedRevisionstringyes
itemsobject[]yes
pagePageInfoyesPageInfo
page.limitintegeryes
page.offsetintegeryes
page.returnedintegeryes
totalintegeryes

​
Example response

{
  "evaluatedRevision": "rev-001",
  "items": [
    {
      "handle": {
        "ref": "handle:abc123",
        "refStability": "stable",
        "targetKind": "text"
      },
      "id": "id-001",
      "isExplicit": true,
      "kind": "header",
      "refId": {},
      "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

{
  "additionalProperties": false,
  "properties": {
    "kind": {
      "enum": [
        "header",
        "footer"
      ]
    },
    "limit": {
      "minimum": 1,
      "type": "integer"
    },
    "offset": {
      "minimum": 0,
      "type": "integer"
    },
    "section": {
      "$ref": "#/$defs/SectionAddress"
    }
  },
  "type": "object"
}

{
  "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"
}