Figma
Get Figma File Structure
Read a Figma file's pages and frames, with the node IDs needed to export or read them.
1 creditRuns in your Figma accountEndpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| identifieraccount · required | account | required | — |
| fileKeystring · required | string | required | Paste a Figma file link (Share → Copy link) or the file key from the URL. Example: |
| depthnumber · optional | number | optional | 1 lists pages only. 2 also lists each page's top-level frames (default). Up to 4. Default: |
| versionstring · optional | string | optional | A version ID from List Figma File Versions. Leave blank for the current version. |
| includeBranchesboolean · optional | boolean | optional | Also list the file's branches. |
Response schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "Open in Figma"
},
"name": {
"type": "string"
},
"pages": {
"type": "array",
"description": "Pages, each with id, name, childCount and children"
},
"fileKey": {
"type": "string"
},
"version": {
"type": "string"
},
"branches": {
"type": "array"
},
"pageCount": {
"type": "number"
},
"editorType": {
"type": "string",
"description": "figma, figjam, slides, …"
},
"styleCount": {
"type": "number"
},
"lastModified": {
"type": "string"
},
"thumbnailUrl": {
"type": "string"
},
"componentCount": {
"type": "number"
},
"componentSetCount": {
"type": "number"
}
}
}