Figma · Schema

Comment

A comment or reply left by a user.

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name Type Description
id string Unique identifier for comment.
fileKey string The file in which the comment lives.
parentId string If present, the id of the comment to which this is the reply.
createdAt string The UTC ISO 8601 time at which the comment was left.
resolvedAt ['string', 'null'] If set, the UTC ISO 8601 time the comment was resolved.
message string The content of the comment.
orderId ['string', 'null'] The number displayed with the comment in the UI.
reactions array An array of reactions to the comment.
View JSON Schema on GitHub

JSON Schema

figma-files-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.",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for comment."
    },
    "fileKey": {
      "type": "string",
      "description": "The file in which the comment lives."
    },
    "parentId": {
      "type": "string",
      "description": "If present, the id of the comment to which this is the reply."
    },
    "createdAt": {
      "type": "string",
      "description": "The UTC ISO 8601 time at which the comment was left."
    },
    "resolvedAt": {
      "type": "['string', 'null']",
      "description": "If set, the UTC ISO 8601 time the comment was resolved."
    },
    "message": {
      "type": "string",
      "description": "The content of the comment."
    },
    "orderId": {
      "type": "['string', 'null']",
      "description": "The number displayed with the comment in the UI."
    },
    "reactions": {
      "type": "array",
      "description": "An array of reactions to the comment."
    }
  }
}