Figma icon

Figma

Use the Figma API

Figma File → Get File Nodes

AI-generated

Summary

Retrieve specific nodes from a Figma design file by its key, optionally filtering by node IDs and other query parameters.

Inputs

  • Key (required) — The unique identifier of the Figma file from which nodes are retrieved.
  • Query Parameters — Optional parameters to refine the query, such as 'ids' to specify comma-separated node IDs within the file, 'version' for a specific file version, 'depth' to control traversal depth, and other filters as supported by the Figma API.

Output shape

a JSON object containing the requested nodes and their data as returned by the Figma API.

The response will depend on the specified query parameters and the Figma API's nodes endpoint. The node key ('Key') is mandatory. Pagination or partial data retrieval is managed through standard Figma API query parameters included in the 'Query Parameters' collection.

Examples

Example 1: Retrieve nodes by IDs in a Figma file

Provide the file 'Key' and set 'ids' in Query Parameters as a comma-separated list of node IDs to retrieve those specific nodes from the file.

Discussion