List Annotations
annotation_listRead native annotations from a Figma page or node. Optionally include file-wide annotation categories in the result.
Instructions
Read the native annotations on a page or node (and subtree); exactly one of pageId or nodeId is required. The file's annotation categories are returned by default; pass includeCategories: false to omit them. Page loading is bounded; a page-scoped failure returns its structured error directly and successful reads include coverage.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| nodeId | No | The node ID to get annotations from. Exactly one of pageId or nodeId is required. | |
| pageId | No | The page ID to get annotations from. Exactly one of pageId or nodeId is required. | |
| includeCategories | No | Include the file's global annotation categories in the result. Defaults to true; pass false to omit them. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| error | No | ||
| coverage | No | Page-scan coverage; partial read data remains usable when complete is false | |
| categories | No | List of global annotation categories | |
| annotatedNodes | No | Grouped annotations, preserving the owning node in page and node modes |