Figma
Read Design files, collaborate with comments, and export node images.
Connectors
Choose the connector that matches your authentication method. The options below use the names shown in StackAI.
Figma
Personal access token
Figma
Connect to Figma with a scoped personal access token.
Set up in Figma
Prepare the Figma account or service that the workflow will access. Grant access to the required resources and operations.
Personal access token: Create a Figma personal access token with current_user:read, projects:read, file_content:read, file_comments:read, and file_comments:write scopes.
Set up in StackAI
Open Settings → Connections, add a connection, and select Figma.
Enter the credentials and connection details in the fields below.
Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.
Connection fields
Personal access token
Yes
Create a Figma personal access token with current_user:read, projects:read, file_content:read, file_comments:read, and file_comments:write scopes. Provider instructions.
Verify the connection
Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.
If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.
Use an action
Add the required Figma action to the workflow.
Select a connection when the action requests one.
Complete the required fields. Use the reference picker when a value comes from another workflow step.
Run the workflow and inspect the action’s output. Check the result before using it in a later step.
Actions
Get File
Get the structure and metadata of a Figma Design file.
Required permissions: file_content:read, projects:read.
Inputs
Team ID
string
Yes
The numeric Figma team ID copied from the team URL.
Project
select (string)
Yes
Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection.
File
select (string)
Yes
Select a Figma file after choosing the project, or type its key. Options load from the selected connection.
Document Depth
integer
No
Number of document-tree levels to return. Minimum: 1. Maximum: 10. Default: 2.
Outputs
File Key
string
The exact Figma file key.
File Name
string
The Figma Design file name.
Role
string
The connected user's role on the file.
Last Modified
datetime
The file's last-modified time.
Editor Type
string
The confirmed Design editor type.
Thumbnail URL
string
A Figma thumbnail URL when available.
Version
string
The returned file version identifier.
Document
object
The typed Figma document tree at the requested depth.
List File Comments
List comments on a Figma file.
Required permissions: file_comments:read, projects:read.
Inputs
Team ID
string
Yes
The numeric Figma team ID copied from the team URL.
Project
select (string)
Yes
Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection.
File
select (string)
Yes
Select a Figma file after choosing the project, or type its key. Options load from the selected connection.
Return Markdown
boolean
No
Return supported comment formatting as Markdown. Default: false.
Outputs
File Key
string
The file whose comments were returned.
Comments
object_array
Typed comments on the Figma file.
Comment Count
integer
Number of comments returned.
Add Comment to File
Add a comment or reply to a Figma file.
Required permissions: file_comments:write, projects:read.
Inputs
Team ID
string
Yes
The numeric Figma team ID copied from the team URL.
Project
select (string)
Yes
Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection.
File
select (string)
Yes
Select a Figma file after choosing the project, or type its key. Options load from the selected connection.
Comment
textarea
Yes
The exact comment text to add.
Reply To Comment ID
string
No
The root comment ID to reply to.
Outputs
Comment ID
string
The exact created comment ID.
File Key
string
The file containing the comment.
Comment
object
The typed created Figma comment.
Export File Images
Render selected nodes from a Figma file as images.
Required permissions: file_content:read, projects:read.
Inputs
Team ID
string
Yes
The numeric Figma team ID copied from the team URL.
Project
select (string)
Yes
Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection.
File
select (string)
Yes
Select a Figma file after choosing the project, or type its key. Options load from the selected connection.
Node IDs
textarea
Yes
Comma-separated Figma node IDs to render.
Format
select (string)
No
The output image format. Available values: PNG, JPG, SVG, PDF. Default: png.
Scale
number
No
Render scale from 0.01 through 4. Minimum: 0.01. Maximum: 4. Default: 1.0.
Outline SVG Text
boolean
No
Render SVG text as outlines for visual fidelity.
Outputs
File Key
string
The file containing the exported nodes.
Images
object_array
One URL result for each requested node.
Image Count
integer
Number of requested node results.
List Team Projects
List projects visible in a Figma team.
Required permissions: projects:read.
Inputs
Team ID
string
Yes
The numeric Figma team ID copied from the team URL.
Outputs
Team ID
string
The team whose projects were returned.
Team Name
string
The Figma team name.
Projects
object_array
Projects visible to the connected user.
Project Count
integer
Number of visible projects.
Important behavior
Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.
The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.
Last updated
Was this helpful?

