Figma

Overview

Figma is a collaborative browser-based interface design tool that lets teams create, prototype, and inspect layouts in real time. With the Figma integration in SquadOS, your agents can read design files, extract tokens and variables, comment on projects, manage webhooks, and download node images directly from the Figma API.

• Official website: https://www.figma.com/
• Composio documentation: docs.composio.dev/toolkits/figma

Authentication

This tool uses OAuth 2.0 (OAUTH2) or API key (API_KEY) to connect.

You will need one of the following authentication options:

Field	Required	Description
OAuth 2.0 authorization	Yes (OAuth mode)	Authorize access to your Figma account via the Composio connection page.
api_key	Yes (API_KEY mode)	Personal access token generated in the Figma dashboard under Settings → Security → Personal access tokens.

How to get credentials

See the Composio documentation for the required connection fields.

Tip

Prefer OAuth 2.0 for accessing team files. Use a personal API key only for personal automations, as it grants access to all files on your account.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Figma.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you authorize access (OAuth) or enter the credentials obtained above.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)

Available actions

Add a comment to a file

FIGMA_ADD_A_COMMENT_TO_A_FILE

Posts a new comment to a Figma file or branch, optionally replying to an existing root comment (replies cannot be nested); region_height and region_width in client_meta must be positive if defining a comment region.

Input parameters

Name	Type	Required	Description
message	string	Yes	Text content of the comment.
file_key	string	Yes	Figma file key or branch key. Extract from the file URL: https://www.figma.com/design/FILE_KEY/... or https://www.figma.com/file/FILE_KEY/... — the alphanumeric string between design/ or file/ and the next slash.
comment_id	string	No	ID of an existing root comment to reply to. Replies cannot be made to other replies.
client_meta	object	No	Dictionary specifying the comment’s position. Valid formats: 1) Absolute coordinates: {x, y} 2) Node-relative: {node_id, node_offset: {x, y}} 3) Absolute region: {x, y, region_height, region_width, comment_pin_corner?} 4) Node-relative region: {node_id, node_offset: {x, y}, region_height, region_width, comment_pin_corner?}. While technically optional, providing this parameter is strongly recommended.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Add a reaction to a comment

FIGMA_ADD_A_REACTION_TO_A_COMMENT

Posts a specified emoji reaction to an existing comment in a Figma file or branch, requiring valid file_key and comment_id.

Input parameters

Name	Type	Required	Description
emoji	string	Yes	The emoji to use for the reaction, specified as a shortcode (e.g., :heart:, :+1::skin-tone-2:).
file_key	string	Yes	Identifier of the Figma file or branch to which the comment reaction will be posted.
comment_id	string	Yes	The unique identifier of the comment to which the reaction should be added.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create a webhook

FIGMA_CREATE_A_WEBHOOK

Creates a Figma webhook to receive POST notifications when specific events occur. Webhooks can monitor events at team, project, or file scope. Upon creation, Figma sends an initial PING event to verify your endpoint (unless status is PAUSED).

Input parameters

Name	Type	Required	Description
status	string ("ACTIVE" or "PAUSED")	No	Initial webhook status. ACTIVE (default): operational, receives an initial PING on creation. PAUSED: inactive, no events.
context	string ("team", "project", or "file")	No	Scope of the webhook. team: monitors all files in a team. project: monitors all files in a project. file: monitors a specific file.
team_id	string	No	DEPRECATED: Use context='team' with context_id instead.
endpoint	string	Yes	Publicly accessible HTTPS URL (max 2048 chars) that receives POST requests from Figma when the event triggers.
passcode	string	Yes	Secret string (max 100 chars) included in the webhook payload for verification.
context_id	string	No	ID of the context (team, project, or file) to monitor. Required when context is specified.
event_type	string	Yes	Type of event that triggers the webhook: FILE_COMMENT, FILE_DELETE, FILE_UPDATE, FILE_VERSION_UPDATE, or LIBRARY_PUBLISH.
description	string	No	Optional human-readable description for the webhook (max 150 chars).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create dev resources

FIGMA_CREATE_DEV_RESOURCES

Creates and attaches multiple uniquely-URLed development resources to specified Figma nodes, up to 10 per node.

Input parameters

Name	Type	Required	Description
dev_resources	array	Yes	List of development resources to create.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create, modify, or delete variables

FIGMA_CREATE_MODIFY_DELETE_VARIABLES

Manages variables, collections, modes, and their values in a Figma file via batch create/update/delete operations; use temporary IDs to link new related items in one request and ensure variableModeValues match the target variable’s resolvedType.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The key of the Figma file or branch to modify variables in.
variables	array	No	List of operations for variables (CREATE, UPDATE, DELETE). Maximum 5000 variables per collection.
variableModes	array	No	List of operations for modes (CREATE, UPDATE, DELETE). Maximum 40 modes per collection.
variableModeValues	array	No	List of value assignments for variables in specific modes.
variableCollections	array	No	List of operations for variable collections (CREATE, UPDATE, DELETE).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete a comment

FIGMA_DELETE_A_COMMENT

Deletes a specific comment from a Figma file or branch, provided the authenticated user is the original author of the comment.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The key of the Figma file or branch from which the comment will be deleted.
comment_id	string	Yes	The unique string identifier of the comment to be deleted. Only the author of the comment can delete it.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete a reaction

FIGMA_DELETE_A_REACTION

Deletes a specific emoji reaction from a comment in a Figma file; the user must have originally created the reaction.

Input parameters

Name	Type	Required	Description
emoji	string	Yes	The specific emoji character (e.g., ❤️, 👍) of the reaction to delete.
file_key	string	Yes	Key of the file or branch containing the comment reaction to be deleted.
comment_id	string	Yes	Identifier of the comment from which the reaction will be removed.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete a webhook

FIGMA_DELETE_A_WEBHOOK

Permanently deletes an existing webhook, identified by its unique webhook_id; this operation is irreversible.

Input parameters

Name	Type	Required	Description
webhook_id	string	Yes	The unique identifier of the webhook to be deleted.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete dev resource

FIGMA_DELETE_DEV_RESOURCE

Deletes a development resource (used to link Figma design elements to external developer information like code or tasks) from a specified Figma file.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	Identifier of the Figma file from which to delete the dev resource. Must be a main file key, not a branch key.
dev_resource_id	string	Yes	Identifier of the dev resource to delete from the file.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Design tokens to Tailwind

FIGMA_DESIGN_TOKENS_TO_TAILWIND

Convert design tokens to Tailwind CSS configuration. Two-step workflow: 1) call FIGMA_EXTRACT_DESIGN_TOKENS with a Figma file_key to extract design tokens; 2) pass the returned DesignTokens object to this action’s tokens parameter. Generates tailwind.config.ts/js with theme extensions and optionally globals.css with font imports. Shadow colors can be provided in string format (e.g., "rgba(15, 110, 110, 0.32)") or dictionary format.

Input parameters

Name	Type	Required	Description
prefix	string	No	Prefix for generated token names (e.g., brand-).
tokens	object	Yes	Design tokens object obtained from the FIGMA_EXTRACT_DESIGN_TOKENS action output. Contains colors, typography, spacing, border_radius, shadows, total_tokens, and sources.
config_format	string	No	Output format: ts for TypeScript or js for JavaScript.
include_font_imports	boolean	No	Include @import statements for Google Fonts.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Detect Background Layers

FIGMA_DETECT_BACKGROUND

Detect background layers for selected nodes in a Figma file. Analyzes the document structure and identifies potential background elements using geometric analysis (bounding box overlap/containment), z-index ordering, visual properties (fills, node types), and naming conventions. Returns background candidates with confidence scores (0–1) and explanations.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	File key extracted from a Figma Design file URL. Example: abc123XYZ from URL figma.com/design/abc123XYZ/My-Design. NOT supported: FigJam boards or Slides.
search_depth	integer	No	How many levels up in the node hierarchy to search for backgrounds. Higher values find more distant ancestors but take longer. Default: 3.
target_node_ids	array	Yes	List of node IDs to find background layers for. Node IDs can be found in Figma URLs after node-id= parameter, e.g., 1:2 or 123:456.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Discover Figma Resources

FIGMA_DISCOVER_FIGMA_RESOURCES

Smart Figma resource discovery — extract IDs from any Figma URL. Supports all URL formats: /file/, /design/, /board/, /proto/, /slides/. Discovery workflow: team_id → projects → files → nodes. Use extracted IDs with GetFileJson, DetectBackground, etc.

Input parameters

Name	Type	Required	Description
team_id	string	No	Team ID to list all projects from. Get this from team URL: https://www.figma.com/files/team/YOUR_TEAM_ID/Team-Name. Returns list of projects with IDs and names. Cannot be inferred from user identity; must come from a team URL.
file_key	string	No	File key to extract all node IDs from. Returns hierarchical list of all nodes with IDs, names, types, and paths.
figma_url	string	No	Full Figma URL to extract file_key, node_id, and team_id from. Works with any Figma URL format. This is the easiest way to get all IDs you need.
max_depth	integer	No	Maximum tree depth to traverse when discovering nodes. 2=pages+frames, 3=pages+frames+components, etc. Higher values find more nodes but take longer.
project_id	string	No	Project ID to list all files from. Returns files with keys, names, and thumbnails.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Download Figma Images

FIGMA_DOWNLOAD_FIGMA_IMAGES

Download images from Figma file nodes. Renders specified nodes as images and downloads them. Supports PNG, SVG, JPG, and PDF formats. NOTE: returned image URLs expire shortly after generation — download them immediately.

Input parameters

Name	Type	Required	Description
scale	number	No	Image scaling factor for PNG/JPG exports (0.01 to 4). Default is 2 for retina quality. Ignored for SVG/PDF.
images	array	Yes	A list of image download requests. Each item must be an object with node_id (string, required), file_name (string, required), and optionally format (defaults to png).
file_key	string	Yes	The Figma file key extracted from a Figma URL. Identifies which Figma file to download images from.
svg_include_id	boolean	No	For SVG exports only: include element IDs in the SVG output. Defaults to false.
svg_outline_text	boolean	No	For SVG exports only: convert text to paths for accurate rendering. Defaults to true.
svg_simplify_stroke	boolean	No	For SVG exports only: simplify strokes for cleaner SVG output. Defaults to true.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Extract design tokens

FIGMA_EXTRACT_DESIGN_TOKENS

Extract design tokens from Figma files by combining styles, variables, and node-extracted values. Only values defined as Figma styles or variables are captured. Requires file_variables:read scope and a Figma plan that supports variables for full output; if variables return empty, supplement with FIGMA_GET_LOCAL_VARIABLES.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The Figma file key (e.g., aA1b2Cd3E4F5g6H7i8J9k0L). Extract from Figma URLs like figma.com/file/FILE_KEY/....
include_variables	boolean	No	Include variables in extraction. Use FIGMA_GET_LOCAL_VARIABLES for full semantic token coverage including variable modes and aliases.
extract_from_nodes	boolean	No	Extract tokens from node properties.
include_local_styles	boolean	No	Include local styles in extraction.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Extract Prototype Interactions

FIGMA_EXTRACT_PROTOTYPE_INTERACTIONS

Extract prototype interactions and animations from Figma files. Analyzes prototype data to extract user interactions (clicks, hovers, etc.), transition animations, component variant states, and user flows/navigation.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The unique file key from a Figma URL. Extract from https://www.figma.com/file/ABC123xyz/MyFileName or https://www.figma.com/design/ABC123xyz/MyFileName.
analyze_components	boolean	No	Extract component variant states.
include_animations	boolean	No	Include detailed animation data.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get activity logs

FIGMA_GET_ACTIVITY_LOGS

Retrieves activity log events from Figma, allowing filtering by event types, time range, and pagination.

Input parameters

Name	Type	Required	Description
limit	integer	No	Maximum number of events per response, for pagination. Defaults to 1000.
order	string ("asc" or "desc")	No	Sort order for events by timestamp.
events	string	No	Comma-separated event types to include. If unspecified, all event types are returned.
end_time	integer	No	Unix timestamp for the latest time for events. Defaults to the current timestamp.
start_time	integer	No	Unix timestamp for the earliest time for events. Defaults to one year ago.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get a webhook

FIGMA_GET_A_WEBHOOK

Retrieves detailed information about a specific webhook by its ID, provided the webhook exists and is accessible to the user.

Input parameters

Name	Type	Required	Description
webhook_id	string	Yes	The unique identifier of the webhook to retrieve.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get comments in a file

FIGMA_GET_COMMENTS_IN_A_FILE

Retrieves all comments from an existing Figma file, returning details like content, author, position, and reactions, with an option for Markdown formatted content.

Input parameters

Name	Type	Required	Description
as_md	boolean	No	If true, comment content will be returned in Markdown format where applicable. Defaults to false.
file_key	string	Yes	Identifier for the Figma file from which to retrieve comments.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get component (Deprecated)

FIGMA_GET_COMPONENT

DEPRECATED: Use FIGMA_GET_FILE_NODES instead. Get component data with automatic simplification. Returns clean, AI-friendly component structure.

Input parameters

Name	Type	Required	Description
node_id	string	Yes	ID of the component node. Must be a component node ID specifically (not a frame or page ID).
file_key	string	Yes	File key that contains the component.
response_detail	string ("minimal" or "full")	No	Level of detail in the response. minimal (default) simplifies for AI. full returns the raw Figma API response.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get component

FIGMA_GET_COMPONENT2

Fetches metadata for a specific component using its unique identifier. Use when you need to retrieve published component details from a team library.

Input parameters

Name	Type	Required	Description
key	string	Yes	The unique identifier of the component.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get component set

FIGMA_GET_COMPONENT_SET

Retrieves detailed metadata for a specific published Figma component set using its unique key.

Input parameters

Name	Type	Required	Description
key	string	Yes	The unique identifier of the component set.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get current user

FIGMA_GET_CURRENT_USER

Retrieves detailed information for the currently authenticated Figma user.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get dev resources

FIGMA_GET_DEV_RESOURCES

Retrieves development resources (e.g., Jira/GitHub links) for a Figma main file, optionally filtering by specific node IDs.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The unique identifier of the Figma design file. Must be the key for a main file, not a branch key.
node_ids	string	No	A comma-separated string of node IDs to filter dev resources. Example: 1:2,100:54. If omitted, returns all dev resources in the file.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get file components

FIGMA_GET_FILE_COMPONENTS

Retrieves published components from a Figma file, which must be a main file (not a branch) acting as a library.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	Key of the Figma file. Must be a main file (not branch) that acts as a library.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get file component sets

FIGMA_GET_FILE_COMPONENT_SETS

Retrieves all published component sets from the specified Figma main file (file_key must not be for a branch).

Input parameters

Name	Type	Required	Description
file_key	string	Yes	Key of the Figma file. Must be a main file key (not a branch key).

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get file json

FIGMA_GET_FILE_JSON

Get Figma Design file data with automatic simplification. IMPORTANT: Only supports Design files (figma.com/design/{file_key}). FigJam board files and Slides files are NOT supported and will return a 400 error. This enhanced version automatically transforms verbose Figma JSON into a clean, AI-friendly format with 70%+ size reduction. Use simplify=False to get the raw API response.

Input parameters

Name	Type	Required	Description
ids	string	No	Comma-separated node IDs to fetch specific nodes. Example: 1:2,1:3. URL node IDs use hyphens (e.g., 1-2); convert to colons (e.g., 1:2) before passing.
depth	integer	No	Tree traversal depth (e.g., 2 for pages and top-level children). Omitting depth on large files can produce extremely large responses or timeouts.
version	string	No	Specific version ID; current version if omitted.
file_key	string	Yes	File key extracted from a Figma Design file URL. NOT supported: FigJam boards or Slides.
geometry	string	No	Set to paths to include vector data.
branch_data	boolean	No	Include branch metadata.
plugin_data	string	No	Comma-separated plugin IDs to include plugin data.
response_detail	string ("minimal" or "full")	No	Level of detail: minimal (default) simplifies for AI; full returns the raw API response.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get file metadata

FIGMA_GET_FILE_METADATA

Get Figma file metadata including name, creator, last modification details, thumbnail, and access information. Use when you need a quick file overview without the full document tree.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	File key to get metadata for. This can be a file key or branch key.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get file nodes

FIGMA_GET_FILE_NODES

Fetch JSON for specific node IDs from a Figma file to avoid full-file payload limits. Use when you already know target node IDs (from shallow file fetch or component listings) or when full-file JSON has hit payload limits. Prefer depth=1 for fast discovery.

Input parameters

Name	Type	Required	Description
ids	string	Yes	Node IDs to retrieve. Provide as comma-separated string (e.g., 1:5,1:6) or as list of strings.
depth	integer	No	How deep into each requested node subtree to traverse. Use depth=1 for fast structure discovery.
version	string	No	Specific version ID to retrieve. Omit for current version.
file_key	string	Yes	Figma file key or branch key extracted from URL.
geometry	string	No	Set to paths to include vector path data in the response.
plugin_data	string	No	Plugin IDs (comma-separated) or shared to include plugin data.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get files in a project

FIGMA_GET_FILES_IN_A_PROJECT

Fetches a list of files in a Figma project, optionally including branch metadata.

Input parameters

Name	Type	Required	Description
project_id	string	Yes	Identifier of the Figma project, typically found in its URL.
branch_data	boolean	No	If true, includes metadata for branches of main files.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get file styles

FIGMA_GET_FILE_STYLES

Retrieves a list of published styles (like colors, text attributes, effects, and layout grids) from a specified main Figma file (not a branch). Only returns PUBLISHED styles from team libraries.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	Key of the main Figma file (not a branch) from which to retrieve published styles.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get image fills

FIGMA_GET_IMAGE_FILLS

Retrieves temporary (14-day expiry) download URLs for all image fills in a Figma file.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The unique identifier of a Figma file. A 22-character alphanumeric string extracted from the file URL.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get library analytics component action data

FIGMA_GET_LIBRARY_ANALYTICS_COMPONENT_ACTION_DATA

Retrieves component insertion and detachment analytics for a specified Figma library, groupable by component or team and filterable by a date range (YYYY-MM-DD).

Input parameters

Name	Type	Required	Description
cursor	string	No	Opaque cursor for pagination, from a previous response’s cursor field; omit for the first page.
end_date	string	No	End date (YYYY-MM-DD) for analytics. Defaults to latest computed week.
file_key	string	Yes	Unique identifier (key) of the Figma library file. Must be a published library file from an Enterprise plan organization.
group_by	string ("component" or "team")	Yes	Dimension to group analytics: component or team.
start_date	string	No	Start date (YYYY-MM-DD) for analytics. Defaults to one year prior.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get library analytics component usage data

FIGMA_GET_LIBRARY_ANALYTICS_COMPONENT_USAGE_DATA

Retrieves component usage analytics for a specified Figma library file, with data groupable by component or file.

Input parameters

Name	Type	Required	Description
cursor	string	No	Opaque string for pagination to fetch the next page of data, obtained from a previous response.
file_key	string	Yes	Unique identifier (key) of the Figma library file. Must be a published library file from an Enterprise plan organization.
group_by	string ("component" or "file")	Yes	Dimension to group analytics data. Use component to see per-component usage stats, or file to see which files use the library.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get library analytics style action data

FIGMA_GET_LIBRARY_ANALYTICS_STYLE_ACTION_DATA

Retrieves style usage analytics (insertions, detachments) for a Figma library, grouped by style or team; if providing a date range, ensure end_date is not before start_date.

Input parameters

Name	Type	Required	Description
cursor	string	No	Opaque cursor for pagination; omit for first page.
end_date	string	No	End date (YYYY-MM-DD) for the analytics data range. Defaults to the most recently computed week.
file_key	string	Yes	Unique identifier (key) of the Figma library. Must be a published library file from an Enterprise plan organization.
group_by	string ("style" or "team")	Yes	Dimension by which to group the library style analytics data.
start_date	string	No	Start date (YYYY-MM-DD) for the analytics data range. Defaults to one year prior.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get library analytics style usage data

FIGMA_GET_LIBRARY_ANALYTICS_STYLE_USAGE_DATA

Retrieves style usage analytics for a published Figma library. Returns data about how styles (colors, text styles, effects, grids) from the library are being used across your organization. Requires Enterprise plan and library_analytics:read scope.

Input parameters

Name	Type	Required	Description
cursor	string	No	Pagination cursor from a previous response’s cursor field. Omit to get the first page of results.
file_key	string	Yes	The unique file key of a published Figma library. Available on Enterprise plans only.
group_by	string ("file" or "style")	Yes	How to group the analytics data: style returns usage stats per style, file returns usage stats per file using the library.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get library analytics variable action data

FIGMA_GET_LIBRARY_ANALYTICS_VARIABLE_ACTION_DATA

Retrieves weekly, paginated analytics data on variable insertions and detachments for a specified Figma library, groupable by variable or team, and filterable by an optional date range. Requires Enterprise plan and library_analytics:read scope.

Input parameters

Name	Type	Required	Description
cursor	string	No	Opaque cursor for pagination from a previous response; omit for the first page.
end_date	string	No	End date (YYYY-MM-DD) for the analytics range. Defaults to the latest computed week.
file_key	string	Yes	Unique identifier (key) of the Figma file (library) for which to retrieve variable analytics data.
group_by	string ("team" or "variable")	Yes	Dimension to group analytics data.
start_date	string	No	Start date (YYYY-MM-DD) for the analytics range. Defaults to one year prior.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get library analytics variable usage data

FIGMA_GET_LIBRARY_ANALYTICS_VARIABLE_USAGE_DATA

Retrieves paginated analytics data on variable usage from a specified Figma library, grouped by file or variable, for libraries with enabled analytics.

Input parameters

Name	Type	Required	Description
cursor	string	No	Opaque cursor for pagination, from a previous response’s cursor field. Omit for the first page.
file_key	string	Yes	Key of the Figma library file for which to retrieve variable usage analytics. Must be a published library from an Enterprise plan organization.
group_by	string ("file" or "variable")	Yes	Dimension for grouping analytics data.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get local variables

FIGMA_GET_LOCAL_VARIABLES

Retrieves all local/remote variables for a Figma file/branch; crucial for obtaining mode-specific values which /v1/files/{file_key}/variables/published omits.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	Key of the Figma file or branch.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get payments

FIGMA_GET_PAYMENTS

Retrieves a user’s payment information for a Figma plugin, widget, or Community file; the authenticated identity must own the resource.

Input parameters

Name	Type	Required	Description
user_id	integer	No	ID of the user whose payment information is sought. Required if plugin_payment_token is not provided.
plugin_id	integer	No	ID of the plugin. If user_id is provided, specify exactly one of community_file_id, plugin_id, or widget_id.
widget_id	integer	No	ID of the widget. If user_id is provided, specify exactly one of the three resource fields.
community_file_id	integer	No	ID of the Community file. If user_id is provided, specify exactly one of the three resource fields.
plugin_payment_token	string	No	Short-lived auth token from getPluginPaymentTokenAsync (Figma Plugin Payments API). If provided, user_id and resource IDs are typically not needed.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get projects in a team

FIGMA_GET_PROJECTS_IN_A_TEAM

Retrieves projects within a specified Figma team that are visible to the authenticated user.

Input parameters

Name	Type	Required	Description
team_id	string	Yes	Identifier of the Figma team from which to list projects. Navigate to your team page in Figma — the team_id will be in the URL: https://www.figma.com/files/team/YOUR_TEAM_ID/Your_Team_Name.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get published variables

FIGMA_GET_PUBLISHED_VARIABLES

Retrieves variables published from a specified Figma file; this API is available only to full members of Enterprise organizations.

Input parameters

Name	Type	Required	Description
file_key	string	Yes	The key of the Figma file from which to retrieve published variables. Must be a main file’s key, not a branch key.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get reactions for a comment

FIGMA_GET_REACTIONS_FOR_A_COMMENT

Retrieves reactions for a specific comment in a Figma file.

Input parameters

Name	Type	Required	Description
cursor	string	No	Pagination cursor from next_page of a previous response. Omit for the first page.
file_key	string	Yes	Key for the Figma file or branch.
comment_id	string	Yes	Identifier of the comment.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get SCIM service provider config

FIGMA_GET_SCIM_SERVICE_PROVIDER_CONFIG

Get Figma’s SCIM service provider configuration. Returns configuration details including which SCIM operations are supported (patch, bulk, filter, etc.), authentication schemes, and service capabilities.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get style

FIGMA_GET_STYLE

Retrieves detailed metadata for a specific style in Figma using its unique style key.

Input parameters

Name	Type	Required	Description
key	string	Yes	The unique identifier (key) of the style to retrieve. Style keys are 40-character hexadecimal hash strings obtained from the GET file styles or GET team styles endpoints. This endpoint only works for styles published in a team library.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get team components

FIGMA_GET_TEAM_COMPONENTS

Retrieves components published in a specific Figma team’s library; the team must have published components, otherwise an empty list is returned.

Input parameters

Name	Type	Required	Description
after	integer	No	Opaque cursor indicating the point after which to retrieve components. Exclusive with the before parameter.
before	integer	No	Opaque cursor indicating the point before which to retrieve components. Exclusive with the after parameter.
team_id	string	Yes	The unique identifier of the Figma team. Navigate to your team page in the Figma web app — the team_id is the numeric string after /team/ in the URL.
page_size	integer	No	Number of components to return per page. Maximum value is 1000.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get team component sets

FIGMA_GET_TEAM_COMPONENT_SETS

Retrieves a paginated list of published component sets (collections of reusable UI elements) from a specified Figma team’s library.

Input parameters

Name	Type	Required	Description
after	integer	No	Cursor for pagination, indicating the point after which to retrieve component sets. Exclusive with before.
before	integer	No	Cursor for pagination, indicating the point before which to retrieve component sets. Exclusive with after.
team_id	string	Yes	The unique identifier of the Figma team. The team_id is in the URL of the team page.
page_size	integer	No	Number of component sets to return in a single page.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get team styles

FIGMA_GET_TEAM_STYLES

Retrieves a paginated list of published styles (fill colors, text styles, effects, grids) from a specified Figma team’s library. Teams without published styles will return an empty list.

Input parameters

Name	Type	Required	Description
after	integer	No	Opaque integer cursor to retrieve styles after this point; use cursor.after from a previous response. Mutually exclusive with before.
before	integer	No	Opaque integer cursor to retrieve styles before this point; use cursor.before from a previous response. Mutually exclusive with after.
team_id	string	Yes	Identifier of the Figma team. The team_id is in the URL of the team page in Figma.
page_size	integer	No	Number of style items to return per page. Maximum supported value is 100.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get webhooks

FIGMA_GET_TEAM_WEBHOOKS

Retrieves all webhooks registered for a specified Figma context (team, project, or file). Uses the Figma Webhooks V2 API endpoint. Note: team_id, project_id, and file_key cannot be discovered programmatically via the API — extract them from Figma URLs or use FIGMA_DISCOVER_FIGMA_RESOURCES.

Input parameters

Name	Type	Required	Description
context	string ("team", "project", or "file")	No	The context type to query webhooks for. Defaults to team for backward compatibility.
context_id	string	Yes	The ID of the context to query webhooks for. For team: the team_id. For project: the project_id. For file: the file_key.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get versions of a file

FIGMA_GET_VERSIONS_OF_A_FILE

Retrieves the version history for a Figma file or branch, as specified by its file_key.

Input parameters

Name	Type	Required	Description
after	integer	No	Version ID for pagination; retrieves versions created strictly after this ID.
before	integer	No	Version ID for pagination; retrieves versions created strictly before this ID.
file_key	string	Yes	The key of the Figma file or branch from which to retrieve the version history. The authenticated user must have access to the file.
page_size	integer	No	Number of version items per page. The API defaults to 30 if this parameter is not sent.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get webhook requests

FIGMA_GET_WEBHOOK_REQUESTS

Retrieves a history of webhook requests for a specific Figma webhook subscription; data is available for requests sent within the last seven days.

Input parameters

Name	Type	Required	Description
webhook_id	string	Yes	The unique identifier of the Figma webhook subscription for which to retrieve past event requests.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Render images of file nodes

FIGMA_RENDER_IMAGES_OF_FILE_NODES

Render Figma nodes as images (PNG, JPG, SVG, PDF). Returns a map of node IDs to temporary image URLs (valid for 30 days). Images are capped at 32 megapixels; larger requests are automatically scaled down.

Input parameters

Name	Type	Required	Description
ids	string	Yes	Comma-separated list of node IDs to render as images. Found in Figma URLs after node-id= or from FIGMA_GET_FILE_JSON response. Example: 1:2,1:3,1:4.
scale	number	No	Image scaling factor between 0.01 and 4.0. Applies to PNG/JPG only; ignored for SVG/PDF.
format	string ("jpg", "pdf", "png", or "svg")	No	Output image format.
version	string	No	Specific version ID of the file to render. Omit to use current version.
file_key	string	Yes	Key of the Figma file or branch.
contents_only	boolean	No	If true, excludes content that overlaps node boundaries.
svg_include_id	boolean	No	(SVG only) If true, includes id attributes (using layer names) on SVG elements.
svg_outline_text	boolean	No	(SVG only) If true, text renders as vector paths (outlines) for exact visual fidelity.
svg_include_node_id	boolean	No	(SVG only) If true, adds data-node-id attribute (with Figma node ID) to SVG elements.
svg_simplify_stroke	boolean	No	(SVG only) If true, simplifies strokes using stroke attribute instead of mask.
use_absolute_bounds	boolean	No	If true, uses full node dimensions ignoring cropping/empty space. Useful for text nodes.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update a webhook

FIGMA_UPDATE_A_WEBHOOK

Updates an existing Figma webhook, identified by webhook_id, allowing modification of its event type, endpoint, passcode, status, or description.

Input parameters

Name	Type	Required	Description
status	string ("ACTIVE" or "PAUSED")	No	Operational status: ACTIVE to receive events, PAUSED to temporarily stop event delivery.
endpoint	string	No	URL of the HTTPS endpoint to receive POST requests for webhook events. Max length 2048.
passcode	string	No	Secret string for your endpoint to verify webhook authenticity. Max length 100.
event_type	string	No	Type of event that triggers the webhook: FILE_COMMENT, FILE_DELETE, FILE_UPDATE, FILE_VERSION_UPDATE, LIBRARY_PUBLISH, or PING.
webhook_id	string	Yes	Unique identifier of the existing webhook to update.
description	string	No	User-friendly description for the webhook. Max length 140 characters. Pass empty string to remove.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update dev resources

FIGMA_UPDATE_DEV_RESOURCES

Updates the name and/or URL of one or more existing Figma Dev Resources, each identified by its unique id.

Input parameters

Name	Type	Required	Description
dev_resources	array	Yes	List of dev resources to update. Each must include its id and can optionally provide a new name and/or url.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.