---
title: "List Word bookmarks available for bookmark placement"
method: GET
path: "/api/v1/templates/{id}/bookmarks"
tags: ["Templates"]
---

# List Word bookmarks available for bookmark placement

`GET /api/v1/templates/{id}/bookmarks`

## Request

- Base URL: `https://api.korala.ai`
- URL: `https://api.korala.ai/api/v1/templates/{id}/bookmarks`
- Auth: one of:
  - API key in header `X-API-Key`
  - `bearer` (a scheme the document does not define)

Renders the DOCX template and reports the named destinations that reached the PDF. A bookmark is invisible in the document and in the rendered output, so this is how you confirm a name exists and see the form the converter rewrote it to.

## Path parameters

- `id` string, required

## Response `200`

- TemplateBookmarksDto
  - `bookmarks` TemplateBookmarkDto[], required: Named destinations in the template rendered as authored, with merge tokens left unsubstituted. Use it to confirm a bookmark name exists and to see the form the converter rewrote it to. The coordinates are from that unmerged layout, so a generated document places the field wherever the bookmark lands once real values have reflowed the page.
    - `name` string, required: Bookmark name as it appears in the rendered PDF. A name containing anything other than letters, digits or hyphens is shown in the converter's rewritten form, e.g. Sig_Seller appears as Sig5FSeller.
    - `pageNumber` number, required: 1-based page number.
    - `x` number, required: Distance from the page left edge, in points.
    - `y` number, required: Distance from the page top edge, in points.
  - `ambiguous` AmbiguousBookmarkDto[], required: Bookmark names that collapse onto one destination once the converter rewrites them. Only one of each group survives, so a field bound to any of them resolves to whichever position won. Rename them to use only letters, digits and hyphens.
    - `key` string, required: The single destination key these names collapse onto.
    - `names` string[], required: Bookmark names in the document that share that key.
  - `missing` string[], required: Bookmark names declared in the DOCX that reached no destination in the rendered document. A field bound to one of these places nothing, and the bookmark list alone would look healthy, so treat a name of your own appearing here as a template setup failure. The most common cause is a bookmark placed after a Word field code (a REF cross-reference, a PAGE number) in the same paragraph: the converter drops it. Move the bookmark before the field. Empty for PDF templates, which have no DOCX to compare against.

## Other responses

- `400`: Malformed UUID in path parameter (`id`).

---

[API](https://skmtc.dev/korala/apis/korala-public-api.md) · [All operations](https://skmtc.dev/korala/apis/korala-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/korala/apis/korala-public-api/revisions/5c4d7810c507?raw)