Components and styles

Figma provides a way to fetch metadata on published components and styles in a team library.

These endpoints are specifically for assets published in a team library. To get metadata for local and subscribed components and styles, use GET /v1/files/:key.

Types

Type	Properties
Component An arrangement of published UI elements that can be instantiated across figma files.	keyString The unique identifier of the component. file_keyString The unique identifier of the figma file which contains the component. node_idString ID of the component node within the figma file. thumbnail_urlString URL link to the component's thumbnail image. nameString Name of the component. descriptionString The description of the component as entered by the publisher. created_atString The UTC ISO 8601 time at which the component was created. updated_atString The UTC ISO 8601 time at which the component was updated. userUser The user who last updated the component. containing_frameFrameInfodefault: {} Data on component's containing frame, if component resides within a frame.
ComponentSet A node containing a set of variants of a component.	keyString The unique identifier of the component set. file_keyString The unique identifier of the figma file which contains the component set. node_idString ID of the component set node within the figma file. thumbnail_urlString URL link to the component set's thumbnail image. nameString Name of the component set. descriptionString The description of the component set as entered by the publisher. created_atString The UTC ISO 8601 time at which the component set was created. updated_atString The UTC ISO 8601 time at which the component set was updated. userUser The user who last updated the component set. containing_frameFrameInfodefault: {} Data on component set's containing frame, if component set resides within a frame.
Style A set of properties that can be applied to nodes.	keyString The unique identifier of the style. file_keyString The unique identifier of the figma file which contains the style. node_idString ID of the style node within the figma file. style_typeString The type of style, as a string enum. FILL TEXT EFFECT GRID thumbnail_urlString URL link to the style's thumbnail image. nameString Name of the style. descriptionString The description of the style as entered by the publisher. created_atString The UTC ISO 8601 time at which the style was created. updated_atString The UTC ISO 8601 time at which the style was updated. userUser The user who last updated the style. containing_frameFrameInfodefault: {} Data on style's containing frame, if style resides within a frame.
FrameInfo Data on the frame a component resides in.	node_idString ID of the frame node within the file. nameString Name of the frame. backgroundColorString Background color of the frame. pageIdString ID of the frame's residing page. pageNameString Name of the frame's residing page. containingStateGroupStringdeprecated Deprecated, use containingComponentSet instead. containingComponentSetString The component set node that contains the frame node.