Figma icon

Figma

Use the Figma API

Figma File → Get File

AI-generated

Summary

Fetches a Figma file's complete document tree and details by its unique file key, optionally customizing the request with various query parameters to tailor the depth, version, and specific content retrieved.

Inputs

  • Key (required) — The unique identifier of the Figma file to retrieve.
  • Query Parameters — Optional parameters to filter or customize the file data returned, such as version ID, tree traversal depth, specific node IDs, and pagination controls.

Output shape

a single JSON object representing the Figma file document and its contents, including nodes and metadata depending on query parameters.

The response shape depends on optional query parameters such as 'version' for fetching a specific file version and 'depth' for limiting document tree traversal. The output is returned as a JSON object; errors and empty content may be indicated by standard HTTP status codes in the response metadata.

Discussion