Figma icon

Figma

Use the Figma API

Component and Style → Get Component

AI-generated

Summary

Retrieve metadata for a Figma component by specifying its unique key.

Inputs

  • Key (required) — The unique component key that identifies the component to retrieve.
  • Query Parameters — Optional parameters to modify the request, such as pagination cursors, version IDs, or additional flags; specify as needed.

Output shape

a single JSON object containing metadata about the specified component.

The component key input is mandatory. Query parameters are optional and support various modifiers documented in Figma API but may not all apply directly to this operation. The operation returns component metadata or an error if the component cannot be found or the key is invalid.

Examples

Example 1: Retrieve basic metadata of a component by its key

Set the 'Key' parameter to the component's unique key; no additional query parameters required.

Discussion