Figma icon

Figma

Use the Figma API

Component and Style → Get Component Set

AI-generated

Summary

Retrieve metadata about a specific Figma component set identified by its unique key, with optional query parameters to refine the response.

Inputs

  • Key (required) — The unique key identifying the component set to retrieve.
  • Query Parameters — Optional parameters to customize the response, such as pagination cursors, depth of document tree traversal, version ID, and other filters supported by the Figma API.

Output shape

a single JSON object containing metadata of the requested component set as returned by the Figma API.

The output JSON corresponds directly to the Figma API response for a component set lookup by key. If the key is invalid or missing, the operation will throw an error. Optional query parameters can modify the result. Pagination and detailed data options depend on provided query parameters.

Discussion