Get Comments

List all comments on a file, including resolved comments and replies.

GET https://api.figma.com/v1/files/:file_key/comments

Authentication

Requires a valid access token with file_content:read scope. Pass via X-Figma-Token header (personal access token) or Authorization: Bearer header (OAuth).

Parameters

Path parameters

The key of the file to retrieve comments from.

Query parameters

Show Optional query parameters

When true, returns comment text formatted as Markdown. Default: false.

Example Request

curl -X GET "https://api.figma.com/v1/files/YOUR_FILE_KEY/comments" \
  -H "X-Figma-Token: YOUR_TOKEN"

Response

{
  "comments": [
    {
      "id": "123",
      "message": "Can we adjust the spacing here?",
      "created_at": "2024-01-15T10:30:00Z",
      "resolved_at": null,
      "user": {
        "id": "456",
        "handle": "designer",
        "img_url": "https://s3-alpha.figma.com/img/..."
      },
      "order_id": "1",
      "client_meta": {
        "x": 100,
        "y": 200,
        "node_id": ["1:23"]
      }
    }
  ]
}

Response Fields

Field	Type	Description
`comments`	`array`	List of comment objects
`comments[].id`	`string`	Unique comment identifier
`comments[].message`	`string`	The comment text
`comments[].created_at`	`string`	ISO 8601 timestamp of when the comment was posted
`comments[].resolved_at`	`string` or `null`	Timestamp when the comment was resolved, or `null` if unresolved
`comments[].user`	`object`	The user who posted the comment
`comments[].order_id`	`string`	Used for ordering comments
`comments[].client_meta`	`object`	Canvas position where the comment is pinned

Filter resolved vs. unresolved comments client-side by checking the resolved_at field. A value of null means the comment is still open.