list.mdx

title	sections.list
sidebarTitle	sections.list
description	List sections in deterministic order with section-target handles.

{/* GENERATED FILE: DO NOT EDIT. Regenerate via pnpm run docapi:sync. */}

Summary

List sections in deterministic order with section-target handles.

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

Expected result

Returns a SectionsListResult with an ordered array of section summaries and their target handles.

Input fields

Field	Type	Required	Description
limit	integer	no
offset	integer	no

Example request

{
  "limit": 50,
  "offset": 0
}

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

{
  "evaluatedRevision": "rev-001",
  "items": [
    {
      "address": {
        "kind": "section",
        "sectionId": "example"
      },
      "breakType": "continuous",
      "handle": {
        "ref": "handle:abc123",
        "refStability": "ephemeral",
        "targetKind": "section"
      },
      "id": "id-001",
      "index": 1,
      "pageSetup": {
        "height": 12.5,
        "width": 12.5
      },
      "range": {
        "endParagraphIndex": 1,
        "startParagraphIndex": 1
      }
    }
  ],
  "page": {
    "limit": 50,
    "offset": 0,
    "returned": 1
  },
  "total": 1
}

Pre-apply throws

• INVALID_INPUT
• CAPABILITY_UNAVAILABLE

Non-applied failure codes

• None

Raw schemas

```json { "additionalProperties": false, "properties": { "limit": { "minimum": 1, "type": "integer" }, "offset": { "minimum": 0, "type": "integer" } }, "type": "object" } ``` ```json { "additionalProperties": false, "properties": { "evaluatedRevision": { "type": "string" }, "items": { "items": { "additionalProperties": false, "properties": { "address": { "$ref": "#/$defs/SectionAddress" }, "breakType": { "enum": [ "continuous", "nextPage", "evenPage", "oddPage" ] }, "columns": { "additionalProperties": false, "properties": { "count": { "minimum": 1, "type": "integer" }, "equalWidth": { "type": "boolean" }, "gap": { "minimum": 0, "type": "number" } }, "type": "object" }, "footerRefs": { "additionalProperties": false, "properties": { "default": { "type": "string" }, "even": { "type": "string" }, "first": { "type": "string" } }, "type": "object" }, "handle": { "additionalProperties": false, "properties": { "ref": { "type": "string" }, "refStability": { "const": "ephemeral" }, "targetKind": { "const": "section" } }, "required": [ "ref", "refStability", "targetKind" ], "type": "object" }, "headerFooterMargins": { "additionalProperties": false, "properties": { "footer": { "minimum": 0, "type": "number" }, "header": { "minimum": 0, "type": "number" } }, "type": "object" }, "headerRefs": { "additionalProperties": false, "properties": { "default": { "type": "string" }, "even": { "type": "string" }, "first": { "type": "string" } }, "type": "object" }, "id": { "type": "string" }, "index": { "minimum": 0, "type": "integer" }, "lineNumbering": { "additionalProperties": false, "properties": { "countBy": { "minimum": 1, "type": "integer" }, "distance": { "minimum": 0, "type": "number" }, "enabled": { "type": "boolean" }, "restart": { "enum": [ "continuous", "newPage", "newSection" ] }, "start": { "minimum": 1, "type": "integer" } }, "required": [ "enabled" ], "type": "object" }, "margins": { "additionalProperties": false, "properties": { "bottom": { "minimum": 0, "type": "number" }, "gutter": { "minimum": 0, "type": "number" }, "left": { "minimum": 0, "type": "number" }, "right": { "minimum": 0, "type": "number" }, "top": { "minimum": 0, "type": "number" } }, "type": "object" }, "oddEvenHeadersFooters": { "type": "boolean" }, "pageBorders": { "additionalProperties": false, "oneOf": [ { "required": [ "display" ] }, { "required": [ "offsetFrom" ] }, { "required": [ "zOrder" ] }, { "required": [ "top" ] }, { "required": [ "right" ] }, { "required": [ "bottom" ] }, { "required": [ "left" ] } ], "properties": { "bottom": { "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ], "properties": { "color": { "type": "string" }, "frame": { "type": "boolean" }, "shadow": { "type": "boolean" }, "size": { "minimum": 0, "type": "number" }, "space": { "minimum": 0, "type": "number" }, "style": { "type": "string" } }, "type": "object" }, "display": { "enum": [ "allPages", "firstPage", "notFirstPage" ] }, "left": { "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ], "properties": { "color": { "type": "string" }, "frame": { "type": "boolean" }, "shadow": { "type": "boolean" }, "size": { "minimum": 0, "type": "number" }, "space": { "minimum": 0, "type": "number" }, "style": { "type": "string" } }, "type": "object" }, "offsetFrom": { "enum": [ "page", "text" ] }, "right": { "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ], "properties": { "color": { "type": "string" }, "frame": { "type": "boolean" }, "shadow": { "type": "boolean" }, "size": { "minimum": 0, "type": "number" }, "space": { "minimum": 0, "type": "number" }, "style": { "type": "string" } }, "type": "object" }, "top": { "additionalProperties": false, "oneOf": [ { "required": [ "style" ] }, { "required": [ "size" ] }, { "required": [ "space" ] }, { "required": [ "color" ] }, { "required": [ "shadow" ] }, { "required": [ "frame" ] } ], "properties": { "color": { "type": "string" }, "frame": { "type": "boolean" }, "shadow": { "type": "boolean" }, "size": { "minimum": 0, "type": "number" }, "space": { "minimum": 0, "type": "number" }, "style": { "type": "string" } }, "type": "object" }, "zOrder": { "enum": [ "front", "back" ] } }, "type": "object" }, "pageNumbering": { "additionalProperties": false, "properties": { "chapterSeparator": { "enum": [ "hyphen", "period", "colon", "emDash", "enDash" ], "type": "string" }, "chapterStyle": { "minimum": 1, "type": "integer" }, "format": { "enum": [ "decimal", "lowerLetter", "upperLetter", "lowerRoman", "upperRoman", "numberInDash" ] }, "start": { "minimum": 1, "type": "integer" } }, "type": "object" }, "pageSetup": { "additionalProperties": false, "properties": { "height": { "minimum": 0, "type": "number" }, "orientation": { "enum": [ "portrait", "landscape" ] }, "paperSize": { "type": "string" }, "width": { "minimum": 0, "type": "number" } }, "type": "object" }, "range": { "additionalProperties": false, "properties": { "endParagraphIndex": { "minimum": 0, "type": "integer" }, "startParagraphIndex": { "minimum": 0, "type": "integer" } }, "required": [ "startParagraphIndex", "endParagraphIndex" ], "type": "object" }, "sectionDirection": { "enum": [ "ltr", "rtl" ] }, "titlePage": { "type": "boolean" }, "verticalAlign": { "enum": [ "top", "center", "bottom", "both" ] } }, "required": [ "id", "handle", "address", "index", "range" ], "type": "object" }, "type": "array" }, "page": { "$ref": "#/$defs/PageInfo" }, "total": { "minimum": 0, "type": "integer" } }, "required": [ "evaluatedRevision", "total", "items", "page" ], "type": "object" } ```