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 files:read,file_comments:write
base_url
stringDefaults to https://api.figma.com

Actions

Posts a new comment reaction on a file comment.

Action Parameters

file_key
stringRequired
comment_id
stringRequired
emoji
stringRequired

Action Response

data
object
successful
boolean
error

Returns all webhook requests sent within the last week. useful for debugging.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
successful
boolean
error

The api for enterprise members enables listing of local and remote variables in files and adds boundvariables to file details. it uses the same endpoint for variable details and modes, excluding published modes.

Action Parameters

file_key
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint lists all projects within a specified team, visible only to the authenticated user or token owner. however, obtaining a team id programmatically with a token is not possible; it requires navigating to a team page url.

Action Parameters

team_id
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a specific comment. only the person who made the comment is allowed to delete it.

Action Parameters

file_key
stringRequired
comment_id
stringRequired

Action Response

data
object
successful
boolean
error

Get a paginated list of published component sets within a team library.

Action Parameters

team_id
stringRequired
page_size
integerDefaults to 30
after
integer
before
integer

Action Response

data
object
successful
boolean
error

Get a list of published styles within a file library.

Action Parameters

file_key
stringRequired

Action Response

data
object
successful
boolean
error

Get metadata on a component set by key.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

Get a webhook by id.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
successful
boolean
error

Deletes a specific comment reaction. only the person who made the reaction is allowed to delete it.

Action Parameters

file_key
stringRequired
comment_id
stringRequired
emoji
stringRequired

Action Response

data
object
successful
boolean
error

Delete a dev resource from a file

Action Parameters

file_key
stringRequired
dev_resource_id
stringRequired

Action Response

data
object
successful
boolean
error

Get a list of all the files within the specified project.

Action Parameters

project_id
stringRequired
branch_data
boolean

Action Response

data
object
successful
boolean
error

Get metadata on a component by key.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

Posts a new comment on the file.

Action Parameters

file_key
stringRequired
message
stringRequired
comment_id
string
client_meta
object

Action Response

data
object
successful
boolean
error

Renders images from a file, outputs node ids to image urls map; errors omitted. supports up to 32 megapixels, scales down larger images, assets expire in 30 days. null values in map indicate failed renderings. use ids parameter for multiple renders.

Action Parameters

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

Action Response

data
object
successful
boolean
error

The get /v1/files/:file key/variables/published api, for enterprise org members, fetches published variables, showing id, subscribed id (changes on modification), omitting modes for collections, and updates updatedat for changes.

Action Parameters

file_key
stringRequired

Action Response

data
object
successful
boolean
error

This endpoint fetches the version history of a file, allowing you to see the progression of a file over time. you can then use this information to render a specific version of the file, via another endpoint.

Action Parameters

file_key
stringRequired
page_size
integer
before
integer
after
integer

Action Response

data
object
successful
boolean
error

Get dev resources in a file

Action Parameters

file_key
stringRequired
node_ids
string

Action Response

data
object
successful
boolean
error

Get a paginated list of published components within a team library.

Action Parameters

team_id
stringRequired
page_size
integerDefaults to 30
after
integer
before
integer

Action Response

data
object
successful
boolean
error

Retrieves a json document using ‘file key’ from a figma url. it includes a ‘document’ node of type ‘document’ and a ‘consider components’ mapping node ids to component metadata for source identification.

Action Parameters

file_key
stringRequired
version
string
ids
string
depth
integerDefaults to 1
geometry
string
plugin_data
string
branch_data
boolean

Action Response

data
object
successful
boolean
error

This api endpoint generates download links for user-uploaded images in figma documents, which are represented as fills in shapes. links, tied to image references from the get files output, expire within 14 days.

Action Parameters

file_key
stringRequired

Action Response

data
object
successful
boolean
error

Get metadata on a style by key.

Action Parameters

key
stringRequired

Action Response

data
object
successful
boolean
error

Gets a list of comments left on the file.

Action Parameters

file_key
stringRequired
as_md
boolean

Action Response

data
object
successful
boolean
error

Returns the user information for the currently authenticated user.

Action Parameters

Action Response

data
object
successful
boolean
error

Deletes the specified webhook. this operation cannot be reversed.

Action Parameters

webhook_id
stringRequired

Action Response

data
object
successful
boolean
error

Get a list of published component sets within a file library.

Action Parameters

file_key
stringRequired

Action Response

data
object
successful
boolean
error

Returns a list of activity log events

Action Parameters

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

Action Response

data
object
successful
boolean
error

Get a list of published components within a file library.

Action Parameters

file_key
stringRequired

Action Response

data
object
successful
boolean
error

The text outlines a method for mass-producing dev resources, tracking successes in the links created array and noting failures—due to missing file key, resource limit, or url duplication—in the errors array.

Action Parameters

dev_resources
arrayRequired

Action Response

data
object
successful
boolean
error

The post /v1/files/:file key/variables endpoint lets enterprise members bulk manage variables & collections, including creation, update, and deletion, with specific rules. requests must be less than 4mb and use temporary ids.

Action Parameters

file_key
stringRequired
variableCollections
array
variableModes
array
variables
array
variableModeValues
array

Action Response

data
object
successful
boolean
error

Returns all webhooks registered under the specified team.

Action Parameters

team_id
stringRequired

Action Response

data
object
successful
boolean
error

Get a paginated list of published styles within a team library.

Action Parameters

team_id
stringRequired
page_size
integerDefaults to 30
after
integer
before
integer

Action Response

data
object
successful
boolean
error

Fetches nodes from a figma file using ids and returns them in json with metadata, permissions, and optional vector data. details on documents and components included; nulls for non-existent ids.

Action Parameters

file_key
stringRequired
ids
stringRequired
version
string
depth
integerDefaults to 1
geometry
string
plugin_data
string

Action Response

data
object
successful
boolean
error

Gets a paginated list of reactions left on the comment.

Action Parameters

file_key
stringRequired
comment_id
stringRequired
cursor
string

Action Response

data
object
successful
boolean
error

Bulk update dev resources across files updates ids in links updated if successful. unupdatable resources appear in errors, but may still return a 200 response.

Action Parameters

dev_resources
arrayRequired

Action Response

data
object
successful
boolean
error

Two methods exist for querying user payment info in plugins, widgets, or community files: using plugin payment tokens or providing user and resource ids. queries are limited to resources owned by the querier.

Action Parameters

plugin_payment_token
string
user_id
integer
community_file_id
integer
plugin_id
integer
widget_id
integer

Action Response

data
object
successful
boolean
error

Returns the user information for the currently authenticated user.(DEPRECATED use get_current_user)

Action Parameters

Action Response

data
object
successful
boolean
error

Create a webhook to call an endpoint upon an event. it sends a ping upon creation, but you can pause it during creation and reactivate it when desired.

Action Parameters

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

Action Response

data
object
successful
boolean
error

Update a webhook by id.

Action Parameters

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

Action Response

data
object
successful
boolean
error