Figma’s Commenting mode allows users to leave comments directly on layers or objects on the canvas. This is useful for collaboration when you want to suggest an adjustment, provide feedback, or critique a specific object or layout. You can use the Figma API to access a whole host of information about a comment, from when the comment was made and by whom, to its exact location on the canvas.
There are a number of different properties associated with a comment and comment reactions, that help to give us more context. The following contains all of the properties comments and their reactions will have:
| Type | Properties |
|---|
A comment or reply left by a user. | idString- Unique identifier for comment.
client_metaVector | FrameOffset | Region | FrameOffsetRegion- 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.
file_keyString- The file in which the comment lives.
parent_idString- If present, the id of the comment to which this is the reply.
userUser- The user who left the comment.
created_atString- The UTC ISO 8601 time at which the comment was left.
resolved_atString- If set, the UTC ISO 8601 time the comment was resolved.
order_idNumber- Only set for top level comments. The number displayed with the comment in the UI.
reactionsReaction[]- An array of reactions to the comment.
|
ReactionA reaction left by a user. | userUser- The user who left the reaction.
emojiString- 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 under the top-level emojis and aliases fields, with optional skin tone modifiers when applicable. created_atString- The UTC ISO 8601 time at which the reaction was left.
|