Figma

Learn how to use Figma with Composio

Overview

Enum

FIGMA

Description

A collaborative interface design tool.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to file_read,file_comments:write,file_dev_resources:read,file_dev_resources:write,webhooks:write
base_url
stringDefaults to https://api.figma.com
api_key
stringRequired
base_url
stringDefaults to https://api.figma.com

Actions

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.

Action Parameters

client_meta
object
comment_id
string
file_key
stringRequired
message
stringRequired

Action Response

data
object
error
successful
boolean
Posts a specified emoji reaction to an existing comment in a figma file or branch, requiring valid file key and comment id.

Action Parameters

comment_id
stringRequired
emoji
stringRequired
file_key
stringRequired

Action Response

data
object
error
successful
boolean
Creates a figma webhook for a `team id` to send post notifications for an `event type` to a publicly accessible https `endpoint`; an initial ping is sent unless `status` is `paused`.

Action Parameters

description
string
endpoint
stringRequired
event_type
stringRequired
passcode
stringRequired
status
string
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Creates and attaches multiple uniquely-urled development resources to specified figma nodes, up to 10 per node.

Action Parameters

dev_resources
arrayRequired

Action Response

data
object
error
successful
boolean
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`.

Action Parameters

file_key
stringRequired
variableCollections
array
variableModeValues
array
variableModes
array
variables
array

Action Response

data
object
error
successful
boolean
Deletes a specific comment from a figma file or branch, provided the authenticated user is the original author of the comment.

Action Parameters

comment_id
stringRequired
file_key
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a specific emoji reaction from a comment in a figma file; the user must have originally created the reaction.

Action Parameters

comment_id
stringRequired
emoji
stringRequired
file_key
stringRequired

Action Response

data
object
error
successful
boolean
Permanently deletes an existing webhook, identified by its unique `webhook id`; this operation is irreversible.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Deletes a development resource (used to link figma design elements to external developer information like code or tasks) from a specified figma file.

Action Parameters

dev_resource_id
stringRequired
file_key
stringRequired

Action Response

data
object
error
successful
boolean
Detect background layers for selected nodes. uses geometric analysis, z-index ordering, and visual properties to identify potential background layers.

Action Parameters

file_key
stringRequired
search_depth
integerDefaults to 3
target_node_ids
arrayRequired

Action Response

data
object
error
successful
boolean
🔍 smart figma resource discovery - never guess ids again! 🎯 easiest method: just paste any figma url to get all ids: • file urls: https://www.figma.com/file/abc123/design → get file key • design urls: https://www.figma.com/design/abc123/design → get file key • node urls: ...?node-id=123:456 → get file key + node id • team urls: .../team/123456/... → get team id 🔄 step-by-step discovery: 1. team id → projects list (with project ids) 2. project id → files list (with file keys + thumbnails) 3. file key → nodes list (with node ids + hierarchy) 💡 common workflows: • extract from url: discoverfigmaresources(figma url="...") • browse team: discoverfigmaresources(team id="123") • list files: discoverfigmaresources(project id="proj 456") • find nodes: discoverfigmaresources(file key="abc123") ✨ get file key for getfilejson, node ids for detectbackground, etc.

Action Parameters

figma_url
string
file_key
string
max_depth
integerDefaults to 2
project_id
string
team_id
string

Action Response

data
object
error
successful
boolean
Download images from figma file nodes. renders specified nodes as images and downloads them using mercury's filedownloadable infrastructure. supports png, svg, jpg, and pdf formats.

Action Parameters

file_key
stringRequired
images
arrayRequired
scale
numberDefaults to 2
svg_include_id
boolean
svg_outline_text
booleanDefaults to True
svg_simplify_stroke
booleanDefaults to True

Action Response

data
object
error
successful
boolean
Extract design tokens from figma files. combines styles, variables, and extracted values to create a comprehensive design token system.

Action Parameters

extract_from_nodes
booleanDefaults to True
file_key
stringRequired
include_local_styles
booleanDefaults to True
include_variables
booleanDefaults to True

Action Response

data
object
error
successful
boolean
Extract prototype interactions and animations from figma files. analyzes the prototype data to extract: - user interactions (clicks, hovers, etc.) - transition animations - component variant states - user flows and navigation

Action Parameters

analyze_components
booleanDefaults to True
file_key
stringRequired
include_animations
booleanDefaults to True

Action Response

data
object
error
successful
boolean
Retrieves activity log events from figma, allowing filtering by event types, time range, and pagination.

Action Parameters

end_time
integer
events
string
limit
integer
order
stringDefaults to asc
start_time
integer

Action Response

data
object
error
successful
boolean
Retrieves detailed information about a specific webhook by its id, provided the webhook exists and is accessible to the user.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all comments from an existing figma file, identified by a valid `file key`, returning details like content, author, position, and reactions, with an option for markdown formatted content.

Action Parameters

as_md
boolean
file_key
stringRequired

Action Response

data
object
error
successful
boolean
Get component data with automatic simplification. returns clean, ai-friendly component structure.

Action Parameters

file_key
stringRequired
node_id
stringRequired
simplify
booleanDefaults to True

Action Response

data
object
error
simplified
boolean
successful
boolean
Retrieves detailed metadata for a specific published figma component set using its unique `key`.

Action Parameters

key
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed information for the currently authenticated figma user.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves development resources (e.g., jira/github links) for a figma main file, optionally filtering by specific node ids.

Action Parameters

file_key
stringRequired
node_ids
string

Action Response

data
object
error
successful
boolean
Fetches a list of files in a figma project, optionally including branch metadata.

Action Parameters

branch_data
boolean
project_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves published components from a figma file, which must be a main file (not a branch) acting as a library.

Action Parameters

file_key
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all published component sets from the specified figma main file (file key must not be for a branch).

Action Parameters

file_key
stringRequired

Action Response

data
object
error
successful
boolean
Get figma file data with automatic simplification. this enhanced version automatically transforms verbose figma json into clean, ai-friendly format with: - css-like property names - deduplicated variables - removed empty values - 70%+ size reduction use simplify=false to get raw api response.

Action Parameters

branch_data
boolean
depth
integer
file_key
stringRequired
geometry
string
ids
string
include_raw
boolean
plugin_data
string
simplify
booleanDefaults to True
version
string

Action Response

data
object
error
raw_data
simplified
boolean
successful
boolean
Retrieves a list of published styles (like colors, text attributes, effects, and layout grids) from a specified main figma file (not a branch).

Action Parameters

file_key
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves temporary (14-day expiry) download urls for all image fills in a figma file; requires `imageref` from `paint` objects to map urls.

Action Parameters

file_key
stringRequired

Action Response

data
object
error
successful
boolean
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).

Action Parameters

cursor
string
end_date
string
file_key
stringRequired
group_by
stringRequired
start_date
string

Action Response

data
object
error
successful
boolean
Retrieves component usage analytics for a specified figma library file (identified by `file key`), with data groupable by 'component' or 'file'.

Action Parameters

cursor
string
file_key
stringRequired
group_by
stringRequired

Action Response

data
object
error
successful
boolean
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.

Action Parameters

cursor
string
end_date
string
file_key
stringRequired
group_by
stringRequired
start_date
string

Action Response

data
object
error
successful
boolean
Retrieves style usage analytics for a figma library (specified by a valid `file key`), allowing data to be grouped by 'file' or 'style'.

Action Parameters

cursor
string
file_key
stringRequired
group_by
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves weekly, paginated analytics data on variable insertions and detachments for a specified figma library (identified by `file key`), groupable by 'variable' or 'team', and filterable by an optional date range.

Action Parameters

cursor
string
end_date
string
file_key
stringRequired
group_by
stringRequired
start_date
string

Action Response

data
object
error
successful
boolean
Retrieves paginated analytics data on variable usage from a specified figma library, grouped by 'file' or 'variable', for libraries with enabled analytics.

Action Parameters

cursor
string
file_key
stringRequired
group_by
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all local/remote variables for a figma file/branch; crucial for obtaining mode-specific values which `/v1/files/{file key}/variables/published` omits.

Action Parameters

file_key
stringRequired

Action Response

data
object
error
successful
boolean
Deprecated: use 'get current user' instead. retrieves user information for the authenticated user.

Action Parameters

Action Response

data
object
error
successful
boolean
Retrieves a user's payment information for a figma plugin, widget, or community file; the authenticated identity must own the resource.

Action Parameters

community_file_id
integer
plugin_id
integer
plugin_payment_token
string
user_id
integer
widget_id
integer

Action Response

data
object
error
successful
boolean
Retrieves projects within a specified figma team that are visible to the authenticated user.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves variables published from a specified figma file; this api is available only to full members of enterprise organizations.

Action Parameters

file_key
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves reactions for a specific comment in a figma file.

Action Parameters

comment_id
stringRequired
cursor
string
file_key
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves detailed metadata for a specific style in figma using its unique style key.

Action Parameters

key
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves components published in a specific figma team's library; the team must have published components, otherwise an empty list is returned.

Action Parameters

after
integer
before
integer
page_size
integerDefaults to 30
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of published component sets (collections of reusable ui elements) from a specified figma team's library.

Action Parameters

after
integer
before
integer
page_size
integerDefaults to 30
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves a paginated list of published styles, such as colors or text attributes, from a specified figma team's library.

Action Parameters

after
integer
before
integer
page_size
integerDefaults to 30
team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves all webhooks registered for a specified figma team.

Action Parameters

team_id
stringRequired

Action Response

data
object
error
successful
boolean
Retrieves the version history for a figma file or branch, as specified by its `file key`.

Action Parameters

after
integer
before
integer
file_key
stringRequired
page_size
integer

Action Response

data
object
error
successful
boolean
Retrieves a history of webhook requests for a specific figma webhook subscription; data is available for requests sent within the last seven days.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Renders specified nodes from a figma file as images (jpg, pdf, png, svg), returning a map of node ids to image urls (or `null` for failed nodes); images expire after 30 days and are capped at 32 megapixels (larger requests are scaled down).

Action Parameters

contents_only
booleanDefaults to True
file_key
stringRequired
format
stringDefaults to png
ids
stringRequired
scale
integer
svg_include_id
boolean
svg_include_node_id
boolean
svg_outline_text
booleanDefaults to True
svg_simplify_stroke
booleanDefaults to True
use_absolute_bounds
boolean
version
string

Action Response

data
object
error
successful
boolean
Updates an existing figma webhook, identified by `webhook id`, allowing modification of its event type, endpoint, passcode, status, or description.

Action Parameters

description
string
endpoint
stringRequired
event_type
stringRequired
passcode
stringRequired
status
string
webhook_id
stringRequired

Action Response

data
object
error
successful
boolean
Updates the name and/or url of one or more existing figma dev resources, each identified by its unique `id`.

Action Parameters

dev_resources
arrayRequired

Action Response

data
object
error
successful
boolean