​Figma Files​

​GET File​

Required Inputs

• ​File Key​

Optional Inputs

• Version (Advanced) - A specific version ID to get. Omitting this will get the current version of the file.

• IDs - A comma separated list of nodes that you care about in the document. If specified, only a subset of the document will be returned corresponding to the nodes listed, their children, and everything between the root node and the listed nodes.

• Depth (Advanced) - Positive integer representing how deep into the document tree to traverse. For example, setting this to 1 returns only Pages, setting it to 2 returns Pages and all top level objects on each page. Not setting this parameter returns all nodes.

• Geometry (Advanced) - Set to 'paths' to export vector data.

• Plugin Data (Advanced) - A comma separated list of plugin IDs and/or the string 'shared'. Any data present in the document written by those plugins will be included in the result in the pluginData and sharedPluginData properties.

​GET File Nodes​

Required Inputs

• ​File Key​

• IDs

​GET Image​

Required Inputs

• ​File Key​

• IDs

Advanced Inputs

• Version - A specific version ID to get. Omitting this will get the current version of the file.

• Scale - A number between 0.01 and 4, the image scaling factor.

• Format - A string enum for the image output format, can be jpg, png, svg, or pdf.

• SVG Include Id - Whether to include id attributes for all SVG elements. Default: false.

• SVG Simplify Stroke - Whether to simplify inside/outside strokes and use stroke attribute if possible instead of <mask>. Default: true.

• Use Absolute Bounds - Use the full dimensions of the node regardless of whether or not it is cropped or the space around it is empty. Use this to export text nodes without cropping. Default: false.

​GET Image Fills​

Required Inputs

• ​File Key​

​Comments​

​GET Comments​

Required Inputs

• ​File Key​

​POST Comments​

Required Inputs

• ​File Key​

• Message - The text contents of the comment to post

Optional Inputs

• Comment Key - The comment to reply to, if any. This must be a root comment, that is, you cannot reply to a comment that is a reply itself (a reply has a parent_id).

Advanced Inputs

• Client Meta - The position of where to place the comment. This can either be an absolute canvas position or the relative position within a frame.

​DELETE Comments​

Required Inputs

• ​File Key​

• Comment Key - Comment id of comment to delete.

​Users​

​GET Me​

Returns the information corresponding to the authenticated user.

​Version History​

​GET File Versions​

Required Inputs

• ​File Key​

​Projects​

​GET Team Projects​

Required Inputs

• ​Team ID​

​GET Project Files​

Required Inputs

• ​Project ID​

​Components and Styles​

​GET Team Components​

Required Inputs

• ​Team ID​

Advanced Inputs

• Page Size - Number of items in a paged list of results. Defaults to 30.

​GET File Components​

Required Inputs

• ​File Key​

​GET Component​

Required Inputs

• Key - The unique identifier of the component.

​GET Team Styles​

Required Inputs

• ​Team ID​

Advanced Inputs

• Page Size - Number of items in a paged list of results. Defaults to 30.

​GET File Styles​

Required Inputs

• ​File Key​

​GET Style​

Required Inputs

• Key - The unique identifier of the style.

Finding Input Values

File Key

To find the key for the file you want to work with, open the file in Figma and obtain the key from the URL in your browser. For example, suppose you are looking for the key for your "UI Pieces" file. You should see a url like this in your browser:

https://www.figma.com/file/JY61PlSmmoRiEHvyrWa4bn/UI-Pieces

The file key is the portion of the portion of the URL after file/: JY61PlSmmoRiEHvyrWa4bn

Team ID

Obtain a team ID by navigating to the team in Figma and extracting the ID from the URL. For example, if you are a member of the "WayScript" team, you can navigate to that team in your browser and you should see a URL like this:

https://www.figma.com/files/team/757969426722171844/Wayscript

The team ID is the portion of the URL after team/: 757969426722171844

Project ID

Obtain a project ID by navigating to the project in Figma and extracting the ID from the URL. For example, if you are viewing the "Script Editor" project, you should see a URL like this:

https://www.figma.com/files/project/4073612/Script-Editor

The project ID is the portion of the URL after project/: 4073612