
Figma List
CertifiedList the comments on a Figma file
Figma List
List the comments on a Figma file
Calls the Figma GET /v1/files/: key/comments endpoint.
type: io.kestra.plugin.figma.comments.ListExamples
List all comments on a Figma file
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
accessToken *Requiredstring
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.
fileKey *Requiredstring
The Figma file key
Found in the file's URL: https://www.figma.com/file/: fileKey/....
asMd booleanstring
Whether to return comment messages as markdown instead of plain text
baseUrl string
https://api.figma.com/v1Figma API base URL
Defaults to the public Figma REST API. Override only to point at a self-hosted proxy or a test server.
fetchType string
FETCHSTOREFETCHFETCH_ONENONEHow to handle the fetched comments
Outputs
row object
The single fetched item
Populated when fetchType is FETCH_ONE.
rows array
The list of fetched items
Populated when fetchType is FETCH.
size integer
The number of items stored or fetched
total integer
The total number of items returned by the Figma API for this request
Only populated for list-shaped responses (e.g. comments, projects, files).
uri string
uriThe internal storage URI of the stored payload
Populated when fetchType is STORE.