home / skills / yuyz0112 / public-api-skills / figma-api

figma-api skill

safe

This skill helps you interact with the Figma REST API by guiding requests, authentication, and resource usage for files, components, and webhooks.

npx playbooks add skill yuyz0112/public-api-skills --skill figma-api

Review the files below or copy the command above to add this skill to your agents.

Files (390)

SKILL.md

2.8 KB

---
name: figma-api
description: This is the OpenAPI specification for the [Figma REST API](https://www.figma.com/developers/api).. Use when working with the Figma API or when the user needs to interact with this API.
metadata:
  api-version: "0.36.0"
  openapi-version: "3.1.0"
  contact: "[email protected]"
---

# Figma API

This is the OpenAPI specification for the [Figma REST API](https://www.figma.com/developers/api).

## How to Use This Skill

This API documentation is split into multiple files for on-demand loading.

**Directory structure:**
```
references/
├── resources/      # 14 resource index files
├── operations/     # 46 operation detail files
└── schemas/        # 105 schema groups, 223 schema files
```

**Navigation flow:**
1. Find the resource you need in the list below
2. Read `references/resources/<resource>.md` to see available operations
3. Read `references/operations/<operation>.md` for full details
4. If an operation references a schema, read `references/schemas/<prefix>/<schema>.md`

## Base URL

- `https://api.figma.com`

## Authentication

Supported methods: **PersonalAccessToken**, **OAuth2**, **OrgOAuth2**. See `references/authentication.md` for details.

## Resources

- **Webhooks** → `references/resources/Webhooks.md` (7 ops) - Interact with team webhooks as a team admin.
- **Files** → `references/resources/Files.md` (6 ops) - Get file JSON, images, and other file-related cont
- **Library Analytics** → `references/resources/Library-Analytics.md` (6 ops) - Get analytics data for your published libraries.
- **Dev Resources** → `references/resources/Dev-Resources.md` (4 ops) - Interact with dev resources in Figma Dev Mode.
- **Comments** → `references/resources/Comments.md` (3 ops) - Interact with file comments.
- **Comment Reactions** → `references/resources/Comment-Reactions.md` (3 ops) - Interact with reactions to file comments.
- **Components** → `references/resources/Components.md` (3 ops) - Get information about published components.
- **Component Sets** → `references/resources/Component-Sets.md` (3 ops) - Get information about published component sets.
- **Styles** → `references/resources/Styles.md` (3 ops) - Get information about published styles.
- **Variables** → `references/resources/Variables.md` (3 ops) - Interact with variables in an Enterprise organizat
- **Projects** → `references/resources/Projects.md` (2 ops) - Get information about projects and files in teams.
- **Users** → `references/resources/Users.md` (1 ops) - Get information about the currently authenticated 
- **Activity Logs** → `references/resources/Activity-Logs.md` (1 ops) - Get activity logs as an organization admin.
- **Payments** → `references/resources/Payments.md` (1 ops) - Get purchase information for your Community resour

Overview

This skill provides a complete OpenAPI specification for the Figma REST API so you can programmatically access files, components, comments, webhooks, analytics, and organization features. It organizes endpoints, operations, and JSON schemas for on-demand loading and integration. Use it to build integrations, automation, or tooling that interact with Figma content and teams.

How this skill works

The specification is split into resource, operation, and schema files that map directly to Figma API endpoints under https://api.figma.com. Authentication supports Personal Access Tokens, OAuth2, and Org OAuth2. To use an operation, locate the resource index, open the operation file for input/output details, and consult referenced schema files for parameter and response structures.

When to use it

Automate exporting or processing Figma file JSON and images.
Build integrations that sync components, styles, or variables with other systems.
Create bots that post or react to comments and thread updates.
Subscribe to or manage webhooks for team events and file changes.
Retrieve analytics for published libraries or audit organization activity.

Best practices

Use scoped OAuth or short-lived tokens for production integrations and refresh flows where supported.
Rate-limit requests and implement exponential backoff; large files and image exports can be heavy.
Prefer retrieving needed nodes or images rather than whole file dumps to reduce payload size.
Validate requests and responses against provided schemas to avoid mismatched fields.
Secure webhook endpoints and verify signatures to prevent unauthorized events.

Example use cases

Generate automated design documentation by fetching file JSON and rendering a catalog of components and styles.
Export images for a design system website by calling image endpoints for specific nodes at required scales.
Sync published components and styles into a design system registry or CMS using component and styles endpoints.
Monitor team activity and set up notifications by creating and consuming webhooks for file updates and comments.
Collect library usage analytics to prioritize maintenance and updates for high-impact components.

FAQ

Which authentication method should I use for server-side integrations?

Use OAuth2 for user-scoped integrations or Personal Access Tokens for simple server-to-server scripts; Org OAuth2 is appropriate for organization-level access where available.

Where do I find the schema for a specific operation response?

Open the operation file in the operations directory, which references schema files located under the schemas directory; use the referenced schema name to find exact fields and types.

Can I create and manage webhooks via the API?

Yes — the Webhooks resource supports creating, listing, and managing team webhooks; always validate webhook signatures and handle retry semantics.