FigmaInstall

Summary

List comments left on a specified Figma file by providing the file key and optional query parameters to filter or paginate the results.

Inputs

• key (required) — The file key identifying the Figma file whose comments you want to list.
• queryParameters — Optional query parameters to filter, paginate, or modify the comments list response. Supported parameters include 'after', 'before', 'limit', 'order', 'cursor', 'as_md' (return comments as markdown), and others as defined.

Output shape

a JSON object representing the list of comments retrieved from the specified file, potentially including pagination information

Requires the 'key' input (file key). The 'queryParameters' input can control limits, order, pagination cursor, and formatting options such as returning comments as markdown. The operation returns the API response directly from Figma's comments endpoint for the specified file.

Examples

Example 1: List comments on a Figma file with default pagination and formatting

key set to the file key, queryParameters left empty or default

Example 2: List comments including markdown formatting and limit the results to 10

key set to the file key, queryParameters includes 'as_md' set to true and 'limit' set to 10