Figma

Connect to Figma to access user files, teams, projects, and design metadata via OAuth 2.0

Supports authentication: OAuth 2.0

Set up the agent connector

Register your Figma app credentials with Scalekit so it can manage the OAuth 2.0 authentication flow and token lifecycle on your behalf. You’ll need a Client ID and Client Secret from the Figma Developers portal.

1. Create a Figma connection in Scalekit

   • In Scalekit dashboard, go to Agent Auth → Create Connection. Search for Figma and click Create.

     

   • In the Configure Figma Connection panel, copy the Redirect URI. It looks like https://<SCALEKIT_ENVIRONMENT_URL>/sso/v1/oauth/<CONNECTION_ID>/callback. You’ll paste this into Figma in the next step.

     

2. Create an app in the Figma Developers portal

   • Go to the Figma Developers portal and sign in. Click + Create a new app.

     

   • Fill in your app name and description, then click Save.

3. Add the redirect URI and copy credentials

   • Open your app and click the OAuth credentials tab.

   • Under Redirect URLs, click Add a redirect URL and paste the Redirect URI you copied from Scalekit.

   • Copy the Client ID from the same tab.

   • Copy the Client Secret. Store it securely — never commit it to source control.

     

   Client secret is shown once

   The Client Secret is masked after the initial creation. If you lose it, you must generate a new one in the Figma app settings.

4. Add credentials in Scalekit

   • In Scalekit dashboard, go to Agent Auth → Connections and open the Figma connection you created.

   • Enter your credentials:

     • Client ID — from the Figma OAuth credentials tab
     • Client Secret — copied in the previous step
     • Scopes — select the permissions your app needs:
       • files:read — read files, nodes, images, components, and styles
       • file_variables:read — read local and published variables
       • file_variables:write — create, update, and delete variables
       • webhooks:write — create, update, and delete team webhooks

     

   • Click Save.

Usage

Connect a user’s Figma account and make API calls on their behalf — Scalekit handles OAuth and token management automatically.

You can interact with Figma in two ways — via direct proxy API calls or via Scalekit optimized tool calls. Scroll down to see the list of available Scalekit tools.

Proxy API calls

Node.js

import { ScalekitClient } from '@scalekit-sdk/node';
import 'dotenv/config';

const connectionName = 'figma'; // get your connection name from connection configurations
const identifier = 'user_123';  // your unique user identifier

// Get your credentials from app.scalekit.com → Developers → Settings → API Credentials
const scalekit = new ScalekitClient(
  process.env.SCALEKIT_ENV_URL,
  process.env.SCALEKIT_CLIENT_ID,
  process.env.SCALEKIT_CLIENT_SECRET
);
const actions = scalekit.actions;

// Step 1: Generate an authorization link and present it to your user
const { link } = await actions.getAuthorizationLink({
  connectionName,
  identifier,
});
console.log('Authorize Figma:', link);
process.stdout.write('Press Enter after authorizing...');
await new Promise(r => process.stdin.once('data', r));

// Step 2: Make API requests via the Scalekit proxy — no token management needed
const me = await actions.request({
  connectionName,
  identifier,
  path: '/v1/me',
  method: 'GET',
});
console.log('Authenticated user:', me);

// Example: fetch a file's document tree
const file = await actions.request({
  connectionName,
  identifier,
  path: '/v1/files/YOUR_FILE_KEY',
  method: 'GET',
});
console.log('File:', file);

Python

import scalekit.client, os
from dotenv import load_dotenv
load_dotenv()

connection_name = "figma"  # get your connection name from connection configurations
identifier = "user_123"   # your unique user identifier

# Get your credentials from app.scalekit.com → Developers → Settings → API Credentials
scalekit_client = scalekit.client.ScalekitClient(
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
    env_url=os.getenv("SCALEKIT_ENV_URL"),
)
actions = scalekit_client.actions

# Step 1: Generate an authorization link and present it to your user
link_response = actions.get_authorization_link(
    connection_name=connection_name,
    identifier=identifier
)
print("Authorize Figma:", link_response.link)
input("Press Enter after authorizing...")

# Step 2: Make API requests via the Scalekit proxy — no token management needed
me = actions.request(
    connection_name=connection_name,
    identifier=identifier,
    path="/v1/me",
    method="GET"
)
print("Authenticated user:", me)

# Example: fetch a file's document tree
file = actions.request(
    connection_name=connection_name,
    identifier=identifier,
    path="/v1/files/YOUR_FILE_KEY",
    method="GET"
)
print("File:", file)

Scalekit tools

Tool list

figma_activity_logs_list

Returns activity log events for an organization (Enterprise only). Includes events for file edits, permissions changes, and user actions.

Name	Type	Required	Description
cursor	string	No	Cursor from previous response for pagination.
end_time	integer	No	Unix timestamp (seconds) to stop fetching events at.
event_type	string	No	Filter by a specific event type, e.g. ‘file.update’.
limit	integer	No	Maximum number of events to return (1-1000, default 100).
order	string	No	Sort order: asc or desc by timestamp. Default is desc.
start_time	integer	No	Unix timestamp (seconds) to start fetching events from.

figma_comment_reaction_create

Adds an emoji reaction to a comment in a Figma file.

Name	Type	Required	Description
comment_id	string	Yes	The ID of the comment to react to.
emoji	string	Yes	The emoji to react with (e.g. ‘:thumbsup:’).
file_key	string	Yes	The unique key of the Figma file.

figma_comment_reaction_delete

Removes the authenticated user’s emoji reaction from a comment in a Figma file.

Name	Type	Required	Description
comment_id	string	Yes	The ID of the comment to remove reaction from.
emoji	string	Yes	The emoji reaction to remove (e.g. ‘:thumbsup:’).
file_key	string	Yes	The unique key of the Figma file.

figma_comment_reactions_list

Returns a list of emoji reactions on a specific comment in a Figma file.

Name	Type	Required	Description
comment_id	string	Yes	The ID of the comment to get reactions for.
cursor	string	No	Pagination cursor for next page of results.
file_key	string	Yes	The unique key of the Figma file.

figma_component_get

Returns metadata for a published component by its key, including name, description, thumbnail, and containing file information.

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

figma_component_set_get

Returns metadata for a published component set (a group of related component variants) by its key.

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

figma_dev_resource_create

Creates a dev resource (external link) attached to a node in a Figma file, such as a link to Storybook, Jira, or documentation.

Name	Type	Required	Description
file_key	string	Yes	The key of the Figma file containing the target node.
name	string	Yes	Display name for the dev resource link.
node_id	string	Yes	The ID of the node to attach the dev resource to.
url	string	Yes	The URL of the external resource.

figma_dev_resource_delete

Permanently deletes a dev resource from a node in a Figma file.

Name	Type	Required	Description
dev_resource_id	string	Yes	The ID of the dev resource to delete.
file_key	string	Yes	The key of the Figma file containing the dev resource.

figma_dev_resource_update

Updates an existing dev resource attached to a node in a Figma file.

Name	Type	Required	Description
dev_resource_id	string	Yes	The ID of the dev resource to update.
name	string	No	New display name for the dev resource.
url	string	No	New URL for the dev resource.

figma_dev_resources_list

Returns dev resources (links to external tools like Storybook, Jira, etc.) attached to nodes in a Figma file.

Name	Type	Required	Description
file_key	string	Yes	The key of the Figma file to get dev resources for.
node_ids	string	No	Comma-separated node IDs to filter by. Omit to return all dev resources in the file.

figma_file_comment_create

Posts a new comment on a Figma file. Can be placed at a specific canvas position or anchored to a specific node.

Name	Type	Required	Description
client_meta	string	No	JSON string specifying position or node anchor for the comment, e.g. {"node_id":"1:2","node_offset":{"x":0,"y":0}}.
file_key	string	Yes	The unique key of the Figma file.
message	string	Yes	The text content of the comment.

figma_file_comment_delete

Deletes a specific comment from a Figma file. Only the comment author or file owner can delete a comment.

Name	Type	Required	Description
comment_id	string	Yes	The ID of the comment to delete.
file_key	string	Yes	The unique key of the Figma file.

figma_file_comments_list

Returns all comments left on a Figma file, including their text, author, position, and resolved status.

Name	Type	Required	Description
as_md	boolean	No	If true, returns comment text as Markdown.
file_key	string	Yes	The unique key of the Figma file.

figma_file_component_sets_list

Returns all published component sets in a Figma file.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.

figma_file_components_list

Returns a list of all published components in a Figma file, including their keys, names, descriptions, and thumbnails.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.

figma_file_get

Returns a Figma file’s full document tree including all nodes, components, styles, and metadata.

Name	Type	Required	Description
depth	integer	No	Depth of the document tree to return (1-4). Lower depth returns faster.
file_key	string	Yes	The unique key of the Figma file (found in the file URL).
version	string	No	A specific version ID to get. Omit to get the current version.

figma_file_image_fills_get

Returns download URLs for all image fills used in a Figma file. Image fills are images that have been applied as fills to nodes.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.

figma_file_images_render

Renders nodes from a Figma file as images (PNG, JPG, SVG, or PDF) and returns URLs to download them.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.
format	string	No	Image format: jpg, png, svg, or pdf. Default is png.
ids	string	Yes	Comma-separated list of node IDs to render.
scale	number	No	Image scale factor (0.01 to 4). Default is 1.
version	string	No	A specific version ID to render from.

figma_file_nodes_get

Returns specific nodes from a Figma file by their node IDs, along with their children and associated styles and components.

Name	Type	Required	Description
depth	integer	No	Depth of the document tree to return for each node.
file_key	string	Yes	The unique key of the Figma file.
ids	string	Yes	Comma-separated list of node IDs to retrieve.
version	string	No	A specific version ID to fetch nodes from.

figma_file_styles_list

Returns all published styles in a Figma file, including color, text, effect, and grid styles.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.

figma_file_variables_local_get

Returns all local variables and variable collections defined in a Figma file. Requires the variables:read scope.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.

figma_file_variables_published_get

Returns all published variables and variable collections from a Figma file’s library. Requires the variables:read scope.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.

figma_file_variables_update

Creates, updates, or deletes variables and variable collections in a Figma file. Accepts a JSON payload describing the changes. Requires the variables:write scope.

Name	Type	Required	Description
file_key	string	Yes	The unique key of the Figma file.
payload	string	Yes	JSON string with variableCollections, variables, and variableModeValues arrays describing changes to apply.

figma_file_versions_list

Returns the version history of a Figma file, including version IDs, labels, descriptions, and creation timestamps.

Name	Type	Required	Description
after	string	No	Return versions created after this version ID (for pagination).
before	string	No	Return versions created before this version ID (for pagination).
file_key	string	Yes	The unique key of the Figma file.
page_size	integer	No	Number of versions to return per page.

figma_library_analytics_component_actions_get

Returns analytics data on component insertion, detachment, and usage actions from a library file. Enterprise only.

Name	Type	Required	Description
cursor	string	No	Pagination cursor from previous response.
end_date	string	No	End date for analytics in YYYY-MM-DD format.
file_key	string	Yes	The key of the library Figma file.
group_by	string	Yes	Dimension to group results by: component or team.
start_date	string	No	Start date for analytics in YYYY-MM-DD format.

figma_library_analytics_component_usages_get

Returns a snapshot of how many times each component from a library is used across the organization. Enterprise only.

Name	Type	Required	Description
cursor	string	No	Pagination cursor from previous response.
file_key	string	Yes	The key of the library Figma file.

figma_library_analytics_style_actions_get

Returns analytics data on style insertion and detachment actions from a library file. Enterprise only.

Name	Type	Required	Description
cursor	string	No	Pagination cursor from previous response.
end_date	string	No	End date for analytics in YYYY-MM-DD format.
file_key	string	Yes	The key of the library Figma file.
group_by	string	Yes	Dimension to group results by: style or team.
start_date	string	No	Start date for analytics in YYYY-MM-DD format.

figma_library_analytics_style_usages_get

Returns a snapshot of how many times each style from a library is used across the organization. Enterprise only.

Name	Type	Required	Description
cursor	string	No	Pagination cursor from previous response.
file_key	string	Yes	The key of the library Figma file.

figma_library_analytics_variable_actions_get

Returns analytics data on variable actions from a library file. Enterprise only.

Name	Type	Required	Description
cursor	string	No	Pagination cursor from previous response.
end_date	string	No	End date for analytics in YYYY-MM-DD format.
file_key	string	Yes	The key of the library Figma file.
group_by	string	Yes	Dimension to group results by: variable or team.
start_date	string	No	Start date for analytics in YYYY-MM-DD format.

figma_library_analytics_variable_usages_get

Returns a snapshot of how many times each variable from a library is used across the organization. Enterprise only.

Name	Type	Required	Description
cursor	string	No	Pagination cursor from previous response.
file_key	string	Yes	The key of the library Figma file.

figma_me_get

Returns the authenticated user’s information including name, email, and profile image URL.

figma_payments_get

Returns payment and plan information for a Figma user or resource, including subscription status and plan type.

Name	Type	Required	Description
resource_id	string	No	The ID of the plugin or widget resource.
resource_type	string	No	The type of resource: plugin or widget.
user_id	string	No	The ID of the user to get payment info for.

figma_project_files_list

Returns all files in a Figma project, including file keys, names, thumbnails, and last modified timestamps.

Name	Type	Required	Description
branch_data	boolean	No	If true, includes branch metadata for each file.
project_id	string	Yes	The ID of the Figma project.

figma_style_get

Returns metadata for a published style by its key, including name, description, style type, and containing file information.

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

figma_team_component_sets_list

Returns all published component sets in a Figma team library, with pagination support.

Name	Type	Required	Description
after	integer	No	Cursor for the next page of results.
before	integer	No	Cursor for the previous page of results.
page_size	integer	No	Number of component sets to return per page.
team_id	string	Yes	The ID of the Figma team.

figma_team_components_list

Returns all published components in a Figma team library, with pagination support.

Name	Type	Required	Description
after	integer	No	Cursor for the next page of results.
before	integer	No	Cursor for the previous page of results.
page_size	integer	No	Number of components to return per page.
team_id	string	Yes	The ID of the Figma team.

figma_team_get

Returns metadata about a Figma team, including its name and member count.

Name	Type	Required	Description
team_id	string	Yes	The ID of the Figma team.

figma_team_projects_list

Returns all projects within a Figma team that the authenticated user has access to.

Name	Type	Required	Description
team_id	string	Yes	The ID of the Figma team.

figma_team_styles_list

Returns all published styles in a Figma team library, with pagination support.

Name	Type	Required	Description
after	integer	No	Cursor for the next page of results.
before	integer	No	Cursor for the previous page of results.
page_size	integer	No	Number of styles to return per page.
team_id	string	Yes	The ID of the Figma team.

figma_team_webhooks_list

Returns all webhooks registered for a Figma team.

Name	Type	Required	Description
team_id	string	Yes	The ID of the Figma team.

figma_webhook_create

Creates a new webhook that sends events to the specified endpoint URL when Figma events occur in a team.

Name	Type	Required	Description
description	string	No	Optional description for the webhook.
endpoint	string	Yes	The HTTPS URL to send webhook payloads to.
event_type	string	Yes	The event type to subscribe to: FILE_UPDATE, FILE_DELETE, FILE_VERSION_UPDATE, FILE_COMMENT, LIBRARY_PUBLISH.
passcode	string	Yes	A passcode included in the webhook payload for verification.
status	string	No	Webhook status: ACTIVE or PAUSED.
team_id	string	Yes	The ID of the team to subscribe to events for.

figma_webhook_delete

Permanently deletes a Figma webhook. This stops all future event deliveries for this webhook.

Name	Type	Required	Description
webhook_id	string	Yes	The ID of the webhook to delete.

figma_webhook_get

Returns details of a specific Figma webhook by its ID, including event type, endpoint, and status.

Name	Type	Required	Description
webhook_id	string	Yes	The ID of the webhook.

figma_webhook_requests_list

Returns the delivery history for a webhook, including request payloads, response codes, and timestamps.

Name	Type	Required	Description
webhook_id	string	Yes	The ID of the webhook.

figma_webhook_update

Updates an existing Figma webhook’s endpoint, passcode, status, or description.

Name	Type	Required	Description
description	string	No	Updated description for the webhook.
endpoint	string	No	New HTTPS URL to send webhook payloads to.
passcode	string	No	New passcode for webhook verification.
status	string	No	Webhook status: ACTIVE or PAUSED.
webhook_id	string	Yes	The ID of the webhook to update.