Get file metadata with the Figma API

Returns the metadata of a file without its content: name, folder, editor type (Figma Design, FigJam, Slides and others), creator, who changed it last and when, thumbnail, the role of the user and the link access. Much cheaper than Get file in the Figma rate limits, so use it first when the question is about the file and not its layers.

Identifier
figma_get_file_metadata

The request

POST https://connect.reportei.com/api/tools/figma_get_file_metadata/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "file_key": "<file_key>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
file_keystringYesKey of the file: the part after /design/, /file/ or /board/ in the URL of the file in Figma. The key of a branch also works.

Supported connections

Your customer connects their Figma account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/figma, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/figma_get_file_metadata. It becomes your agent's tool definition with no conversion.

Other Figma tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.