Figma ListProjectFiles

Figma ListProjectFiles

Certified

List the files of a Figma project

Calls the Figma GET /v1/projects/: project_id/files endpoint.

yaml
type: io.kestra.plugin.figma.projects.ListProjectFiles

List all files of a Figma project

yaml
id: figma_list_project_files
namespace: company.team

tasks:
  - id: list_project_files
    type: io.kestra.plugin.figma.projects.ListProjectFiles
    accessToken: "{{ secret('FIGMA_ACCESS_TOKEN') }}"
    projectId: "987654321"
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 project ID

Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.

Definitions
assetFailureBehaviorstring
Possible Values
IGNOREFAILWARN

Asset failure behavior

Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.

enableAutobooleanstring

Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.

inputsarray

The assets consumed as inputs.

id*string
Min length1
typestring
outputs

The assets produced as outputs.

id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*object
descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
id*string
Min length1
Max length150
type*string
Min length1

Custom asset type

descriptionstring
displayNamestring
metadataobject
Default{}
namespacestring
Min length1
Max length150
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.

Whether to include branch metadata in the response

This plugin passes branchData through as-is; it does not resolve or diff branches.

DefaultFETCH
Possible Values
STOREFETCHFETCH_ONENONE

How to handle the fetched files

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.