Figma Design File Import
To import a design file from Figma, you'll need to provide a personal access token and a file key from Figma. The get the access token, follow the steps in Figma documentation.
The file key can be read from any Figma file URL: https://www.figma.com/file/:key/:title
. For example, in https://www.figma.com/file/12345/Website
, the file key is 12345.
You can optionally initiate conversions to other design formats automatically with the import. (The only supported target format is currently Sketch.)
Returns a design entity and optionally a list of conversions. To access design contents, see the Design Summary endpoint. To access the converted design file, see the Design Conversion endpoint.
Requests
Request Body schema
design_name | string Name of the design. |
figma_token Required | string An access token from Figma. |
figma_filekey Required | string ID of the file in Figma. |
figma_ids | Array of strings Frame IDs to sync. When not specified, all frames are included. |
Array of objects Design file format conversions to intiate automatically with the import. (Only Sketch is supported currently as the target format.) |
Responses
Returns the created design entity or its processing status (in case a conversion was requested).
The requested conversion is invalid or not supported.
Token not provided or invalid.
Rate limit reached.
There was an internal error.
Was this article helpful?