FigmaInstall

Summary

Retrieve metadata for a specific Figma file by providing its unique file key and optional query parameters to customize the response.

Inputs

• Key (required) — The unique file key identifying the Figma file whose metadata you want to retrieve.
• Query Parameters — Optional parameters to filter or modify the metadata response, such as version, depth of document traversal, or branch data inclusion.

Output shape

A single JSON object containing the metadata of the specified Figma file.

The output includes detailed file metadata, potentially influenced by optional query parameters. The response reflects the current or a specified version of the file as indicated by the 'version' query parameter. Errors occur if the 'Key' input is missing.

Examples

Example 1: Retrieve metadata for a Figma file with a specific key.

Set the 'Key' input to the desired file key; optionally specify query parameters such as 'version' to get metadata for a specific version.