Figma GetFile
CertifiedGet a Figma file's document structure
Figma GetFile
Get a Figma file's document structure
Calls the Figma GET /v1/files/: key endpoint. File documents can be very large, so fetchType defaults to STORE.
type: io.kestra.plugin.figma.files.GetFileExamples
Store a Figma file's document structure to internal storage
id: figma_get_file
namespace: company.team
tasks:
- id: get_file
type: io.kestra.plugin.figma.files.GetFile
accessToken: "{{ secret('FIGMA_ACCESS_TOKEN') }}"
fileKey: "abc123XYZ"
Properties
accessToken *string
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 *string
The Figma file key
Found in the file's URL: https://www.figma.com/file/: fileKey/....
assets
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.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset 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.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150baseUrl 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.
branchData booleanstring
Whether to include branch metadata in the response
This plugin passes branchData through as-is; it does not resolve or diff branches.
depth integerstring
Depth of the node tree to traverse
For example 1 returns only the root and its direct children.
fetchType string
STORESTOREFETCHFETCH_ONENONEHow to handle the fetched file document
Defaults to STORE because file documents can be large — storing to internal storage avoids loading the whole JSON tree into the execution context. Use FETCH/FETCH_ONE only for small files.
fileVersion string
A specific file version ID to retrieve
By default the latest version is returned.
geometry string
Geometry data to include
Set to paths to export vector data.
ids array
A list of node IDs to limit the traversal to
By default the whole document is returned.
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.
