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

​
Summary

Get detailed information about a specific bookmark.
  • Operation ID: bookmarks.get
  • API member path: editor.doc.bookmarks.get(...)
  • Mutates document: no
  • Idempotency: idempotent
  • Supports tracked mode: no
  • Supports dry run: no
  • Deterministic target resolution: yes

​
Expected result

Returns a BookmarkInfo object with the bookmark’s name, range, and optional table-column data.

​
Input fields

FieldTypeRequiredDescription
targetobject(kind=“entity”)yes
target.entityType"bookmark"yesConstant: "bookmark"
target.kind"entity"yesConstant: "entity"
target.namestringyes

​
Example request

{
  "target": {
    "entityType": "bookmark",
    "kind": "entity",
    "name": "example"
  }
}

​
Output fields

No fields.

​
Example response

{}

​
Pre-apply throws

  • TARGET_NOT_FOUND
  • CAPABILITY_UNAVAILABLE

​
Non-applied failure codes

  • None

​
Raw schemas

{
  "additionalProperties": false,
  "properties": {
    "target": {
      "additionalProperties": false,
      "properties": {
        "entityType": {
          "const": "bookmark"
        },
        "kind": {
          "const": "entity"
        },
        "name": {
          "type": "string"
        }
      },
      "required": [
        "kind",
        "entityType",
        "name"
      ],
      "type": "object"
    }
  },
  "required": [
    "target"
  ],
  "type": "object"
}

{
  "type": "object"
}