Figma · Schema

Figma Published Component

A published component from a Figma team or file library. Published components are reusable design elements that can be shared across files and teams. This schema represents components as returned by the component endpoints of the Figma REST API.

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name Type Description
key string The globally unique identifier for the component. This key is stable across file versions and can be used to reference the component via the GET /v1/components/{key} endpoint.
file_key string The unique identifier of the Figma file that contains this component.
node_id string The unique identifier of the component node within the Figma file. The node_id combined with file_key can be used to construct a direct URL to the component.
thumbnail_url string A URL to a thumbnail image of the component. Thumbnail URLs are temporary and expire after a period of time.
name string The name of the component as it appears in the assets panel and library.
description string The description of the component as entered by the publisher. Useful for documenting usage guidelines and design intent.
created_at string The UTC ISO 8601 time when the component was first published to the library.
updated_at string The UTC ISO 8601 time when the component was last updated in the library.
user object
containing_frame object
component_set_id stringnull If this component belongs to a component set (variant group), this is the ID of that component set.
documentation_links array An array of documentation links attached to this component, providing external references to code, design specs, or other resources.
View JSON Schema on GitHub