--- title: "Get comments in a file" method: GET path: "/v1/files/{file_key}/comments" tags: ["Comments"] --- # Get comments in a file `GET /v1/files/{file_key}/comments` Gets a list of comments left on the file. ## Path parameters - `file_key` string, required ## Query parameters - `as_md` boolean ## Response `200` Response from the GET /v1/files/{file_key}/comments endpoint. - object - `comments` Comment[], required — An array of comments. - `id` string, required — Unique identifier for comment. - `client_meta` union, required — Positioning information of the comment. Includes information on the location of the comment pin, which is either the absolute coordinates on the canvas or a relative offset within a frame. If the comment is a region, it will also contain the region height, width, and position of the anchor in regards to the region. - Vector — A 2d vector. - `x` number, required — X coordinate of the vector. - `y` number, required — Y coordinate of the vector. - FrameOffset — Position of a comment relative to the frame to which it is attached. - `node_id` string, required — Unique id specifying the frame. - `node_offset` Vector, required — A 2d vector. - `x` number, required — X coordinate of the vector. - `y` number, required — Y coordinate of the vector. - Region — Position of a region comment on the canvas. - `x` number, required — X coordinate of the position. - `y` number, required — Y coordinate of the position. - `region_height` number, required — The height of the comment region. Must be greater than 0. - `region_width` number, required — The width of the comment region. Must be greater than 0. - `comment_pin_corner` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — The corner of the comment region to pin to the node's corner as a string enum. - FrameOffsetRegion — Position of a region comment relative to the frame to which it is attached. - `node_id` string, required — Unique id specifying the frame. - `node_offset` Vector, required — A 2d vector. - `x` number, required — X coordinate of the vector. - `y` number, required — Y coordinate of the vector. - `region_height` number, required — The height of the comment region. Must be greater than 0. - `region_width` number, required — The width of the comment region. Must be greater than 0. - `comment_pin_corner` 'top-left' | 'top-right' | 'bottom-left' | 'bottom-right' — The corner of the comment region to pin to the node's corner as a string enum. - `file_key` string, required — The file in which the comment lives - `parent_id` string — If present, the id of the comment to which this is the reply - `user` User, required — A description of a user. - `id` string, required — Unique stable id of the user. - `handle` string, required — Name of the user. - `img_url` string, required — URL link to the user's profile image. - `created_at` string, date-time, required — The UTC ISO 8601 time at which the comment was left - `resolved_at` string, date-time, nullable — If set, the UTC ISO 8601 time the comment was resolved - `message` string, required — The content of the comment - `order_id` string, nullable, required — Only set for top level comments. The number displayed with the comment in the UI - `reactions` Reaction[], required — An array of reactions to the comment - `user` User, required — A description of a user. - `id` string, required — Unique stable id of the user. - `handle` string, required — Name of the user. - `img_url` string, required — URL link to the user's profile image. - `emoji` string, required — The emoji type of reaction as shortcode (e.g. `:heart:`, `:+1::skin-tone-2:`). The list of accepted emoji shortcodes can be found in [this file](https://raw.githubusercontent.com/missive/emoji-mart/main/packages/emoji-mart-data/sets/14/native.json) under the top-level emojis and aliases fields, with optional skin tone modifiers when applicable. - `created_at` string, date-time, required — The UTC ISO 8601 time at which the reaction was left. ## Other responses - `403` — The request was valid, but the server is refusing action. The user might not have the necessary permissions for a resource, or may need an account of some sort. - `404` — The requested file or resource was not found. - `429` — In some cases API requests may be throttled or rate limited. Please wait a while before attempting the request again (typically a minute). - `500` — An internal server error occurred. ## Changes - **2026-05-06** `2c69c439e847` — 1 info - the endpoint scheme security `PlanAccessToken` was added to the API - **2025-04-24** `8014b4aceb2f` — 1 info - the security scope `file_comments:read` was added to the endpoint's security scheme `OAuth2` - **2024-08-15** `34dbf972c3db` — 1 breaking, 1 info - the response property `comments/items/order_id` became nullable for the status `200` - the response property `comments/items/order_id` became required for the status `200` - **2024-02-02** `31121d0d3d27` — 2 warning, 2 info - added the new `bottom-left` enum value to the `comments/items/client_meta/oneOf[#/components/schemas/FrameOffsetRegion]/comment_pin_corner` response property for the response status `200` - added the new `bottom-left` enum value to the `comments/items/client_meta/oneOf[#/components/schemas/Region]/comment_pin_corner` response property for the response status `200` - removed the `botom-left` enum value from the `comments/items/client_meta/oneOf[#/components/schemas/FrameOffsetRegion]/comment_pin_corner` response property for the response status `200` - removed the `botom-left` enum value from the `comments/items/client_meta/oneOf[#/components/schemas/Region]/comment_pin_corner` response property for the response status `200` - …earlier changes not shown [Full history](https://skmtc.dev/figma/apis/figma-api/changes/v1/files/:file_key/comments/get.md) --- [API](https://skmtc.dev/figma/apis/figma-api.md) · [All operations](https://skmtc.dev/figma/apis/figma-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/figma/figma-api/revisions/d7ab5681d84c/schema)