Table of Contents
A better way to design. Design, prototype, and gather feedback all in one place with Figma.
API Overview
Figma is a cloud-based design platform that enables collaborative design and prototyping. It provides a comprehensive suite of tools for creating user interfaces, including vector editing, wireframing, prototyping, and collaboration features. Figma's intuitive interface and real-time collaboration capabilities make it an ideal tool for teams working on complex design projects. It supports multiple file formats, including Figma, Sketch, XD, and PSD, ensuring seamless collaboration between designers using different software.
Figma's API overview provides comprehensive documentation for developers to integrate Figma's functionality into their applications. The REST APIs allow programmatic access to Figma's core features, such as creating, editing, and managing designs. Webhooks enable real-time notifications for events like file updates or comments, facilitating automated workflows and integrations. Figma also enforces rate limits to prevent excessive API usage and maintain system stability. Developers can access detailed documentation, code samples, and tutorials to guide their integration efforts. By leveraging Figma's API, developers can extend the platform's capabilities and create custom solutions tailored to their specific needs.
API Request Limits
Starter
100 requests/minute
Professional
500 requests/minute
Organization
1000 requests/minute
Enterprise
Custom limits
SDKs
APIs
Method: GET
Description: Returns the documents that the user has access to..
Endpoint: /v1/documents
Parameters: page_size, page_token, user
Method: POST
Description: Creates a new document. Newly created documents default to being untitled..
Endpoint: /v1/documents
Parameters: name, description
Method: GET
Description: Returns the document by the given ID..
Endpoint: /v1/documents/:id
Parameters: id, user
Method: PUT
Description: Updates a document's name and description..
Endpoint: /v1/documents/:id
Parameters: id, name, description
Method: DELETE
Description: Deletes the document..
Endpoint: /v1/documents/:id
Parameters: id
Method: GET
Description: Retrieves a specific image from the specified document..
Endpoint: /v1/images/:key
Parameters: key
Method: GET
Description: Exports one or more images from a document..
Endpoint: /v1/images
Parameters: ids, format, scale, document_id, node_ids
Method: GET
Description: Returns the pages present in the given document..
Endpoint: /v1/documents/:id/pages
Parameters: id
Method: GET
Description: Returns the page by the given ID..
Endpoint: /v1/pages/:id
Parameters: id
Method: POST
Description: Creates a new page in the document..
Endpoint: /v1/pages
Parameters: name, document_id
Method: PUT
Description: Updates the page properties.
Endpoint: /v1/pages/:id
Parameters: id, name
Method: DELETE
Description: Deletes a page.
Endpoint: /v1/pages/:id
Parameters: id, document_id
Method: GET
Description: Returns a list of projects the user has access to..
Endpoint: /v1/projects
Parameters: page_size, page_token, user
Method: GET
Description: Returns a single project..
Endpoint: /v1/projects/:id
Parameters: id, user
Method: GET
Description: Returns the teams that the user is a member of..
Endpoint: /v1/teams
Parameters: page_size, page_token, organization, user
Method: GET
Description: Returns the team by the given ID..
Endpoint: /v1/teams/:id
Parameters: id, user
Method: GET
Description: Returns the user for the given ID..
Endpoint: /v1/users/:id
Parameters: id
Method: GET
Description: Returns a list of versions for the given document..
Endpoint: /v1/documents/:document_id/versions
Parameters: page_size, page_token, document_id
Method: GET
Description: Returns the version by the given ID..
Endpoint: /v1/versions/:id
Parameters: id, document_id
Method: POST
Description: Creates a new version of the document..
Endpoint: /v1/versions
Parameters: id, document_id
FAQ
What is the Figma API?
The Figma API is a set of endpoints that allow developers to interact with Figma files and data.
How do I get started with the Figma API?
First, create a developer account and get an API key. Then, you can use the API to create, edit, and share Figma files.
What are the rate limits for the Figma API?
The Figma API has a rate limit of 100 requests per minute per user. If you exceed this limit, you will be temporarily blocked from making further requests.
How do I authenticate with the Figma API?
You can authenticate with the Figma API using an OAuth 2.0 access token. To get an access token, you will need to create a developer account and register your application.
Can I use the Figma API to create and edit Figma files?
Yes, you can use the Figma API to create, edit, and share Figma files. You can also use the API to access file metadata, such as the file name, description, and collaborators.