provider Comments GET /v1/files/{file_key}/comments
@utdk/figma /v1/files/{file_key}/comments
Get comments in a file
Gets a list of comments left on the file.
file_key path required
File to get comments from. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key.
string
as_md query
If enabled, will return comments as their markdown equivalents when applicable.
boolean

Try it

Authentication
Configure credentials for Figma API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

getcomments
GET/v1/files/{file_key}/comments
Gets a list of comments left on the file.

Parameters

required

File to get comments from. This can be a file key or branch key. Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key.

If enabled, will return comments as their markdown equivalents when applicable.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import figma from '@utdk/figma';

await figma.getcomments()