Figma · Schema

Comment

A comment or reply left by a user on a Figma file. Comments can be pinned to specific locations on the canvas.

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name Type Description
id string Unique identifier for the comment.
file_key string The key of the file the comment belongs to.
parent_id ['string', 'null'] If present, the ID of the comment to which this is a reply.
created_at string The UTC ISO 8601 time at which the comment was left.
resolved_at ['string', 'null'] If set, the UTC ISO 8601 time the comment was resolved.
message string The content of the comment.
order_id ['string', 'null'] Only set for top-level comments. The number displayed with the comment in the UI.
reactions array An array of emoji reactions to the comment.
View JSON Schema on GitHub

JSON Schema

figma-rest-comment-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Comment",
  "type": "object",
  "description": "A comment or reply left by a user on a Figma file. Comments can be pinned to specific locations on the canvas.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the comment."
    },
    "file_key": {
      "type": "string",
      "description": "The key of the file the comment belongs to."
    },
    "parent_id": {
      "type": "['string', 'null']",
      "description": "If present, the ID of the comment to which this is a reply."
    },
    "created_at": {
      "type": "string",
      "description": "The UTC ISO 8601 time at which the comment was left."
    },
    "resolved_at": {
      "type": "['string', 'null']",
      "description": "If set, the UTC ISO 8601 time the comment was resolved."
    },
    "message": {
      "type": "string",
      "description": "The content of the comment."
    },
    "order_id": {
      "type": "['string', 'null']",
      "description": "Only set for top-level comments. The number displayed with the comment in the UI."
    },
    "reactions": {
      "type": "array",
      "description": "An array of emoji reactions to the comment."
    }
  }
}