Figma List

Figma List

Certified

List the comments on a Figma file

Calls the Figma GET /v1/files/: key/comments endpoint.

yaml
type: io.kestra.plugin.figma.comments.List

List all comments on a Figma file

yaml
id: figma_list_comments
namespace: company.team

tasks:
  - id: list_comments
    type: io.kestra.plugin.figma.comments.List
    accessToken: "{{ secret('FIGMA_ACCESS_TOKEN') }}"
    fileKey: "abc123XYZ"
Properties

Figma access token

A personal access token generated from your Figma account settings (Account Settings > Personal access tokens), scoped to what the task needs to do. A valid OAuth 2.0 access token obtained through your own authorization flow also works — this plugin does not implement the OAuth flow itself, only PAT-style bearer tokens passed as-is.

The Figma file key

Found in the file's URL: https://www.figma.com/file/: fileKey/....

Whether to return comment messages as markdown instead of plain text

Defaulthttps://api.figma.com/v1

Figma API base URL

Defaults to the public Figma REST API. Override only to point at a self-hosted proxy or a test server.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

How to handle the fetched comments

The single fetched item

Populated when fetchType is FETCH_ONE.

The list of fetched items

Populated when fetchType is FETCH.

The number of items stored or fetched

The total number of items returned by the Figma API for this request

Only populated for list-shaped responses (e.g. comments, projects, files).

Formaturi

The internal storage URI of the stored payload

Populated when fetchType is STORE.