bookmarks.list

List all bookmarks in the document.

Summary

List all bookmarks in the document.

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

Expected result

Returns a BookmarksListResult containing discovered bookmarks with address and domain data.

Input fields

Field	Type	Required	Description
in	StoryLocator	no	StoryLocator
limit	integer	no
offset	integer	no

Example request

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

Output fields

No fields.

Example response

{}

Pre-apply throws

• CAPABILITY_UNAVAILABLE
• INVALID_INPUT

Non-applied failure codes

• None

Raw schemas

Raw input schema

{
  "additionalProperties": false,
  "properties": {
    "in": {
      "$ref": "#/$defs/StoryLocator"
    },
    "limit": {
      "minimum": 1,
      "type": "integer"
    },
    "offset": {
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object"
}

Raw output schema

{
  "type": "object"
}