Figma · Schema

PublishedComponent

A published component from a team or file library.

CollaborationDesignGraphicsInterfacesPrototypesPrototypingUI/UX

Properties

Name Type Description
key string The globally unique identifier for the component.
file_key string The key of the Figma file containing the component.
node_id string The node ID of the component within the file.
thumbnail_url string A URL to a thumbnail image of the component.
name string The name of the component.
description string The description of the component as entered by the publisher.
created_at string The UTC ISO 8601 time when the component was first published.
updated_at string The UTC ISO 8601 time when the component was last updated.
View JSON Schema on GitHub

JSON Schema

figma-rest-published-component-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "PublishedComponent",
  "type": "object",
  "description": "A published component from a team or file library.",
  "properties": {
    "key": {
      "type": "string",
      "description": "The globally unique identifier for the component."
    },
    "file_key": {
      "type": "string",
      "description": "The key of the Figma file containing the component."
    },
    "node_id": {
      "type": "string",
      "description": "The node ID of the component within the file."
    },
    "thumbnail_url": {
      "type": "string",
      "description": "A URL to a thumbnail image of the component."
    },
    "name": {
      "type": "string",
      "description": "The name of the component."
    },
    "description": {
      "type": "string",
      "description": "The description of the component as entered by the publisher."
    },
    "created_at": {
      "type": "string",
      "description": "The UTC ISO 8601 time when the component was first published."
    },
    "updated_at": {
      "type": "string",
      "description": "The UTC ISO 8601 time when the component was last updated."
    }
  }
}