Figma · 0.1.0

Figma REST API

A Dock-hosted Figma REST API starter integration for Harbor. Importing it creates a local http_api port shell plus a Harbor-safe Figma action set for getting a file, getting file comments, and listing team projects. Figma tokens remain local to Harbor Node.

Community included commentsdesignfigmafilesprojects
Design Category
3 Action templates
0 Workflow templates
Figma Publisher

Service Overview

Figma REST API is the official design collaboration and file api from Figma for files, comments, and projects. This Hub entry keeps the service explanation, setup links, and Harbor-safe import path together so operators can review the integration before local credentials and policies are applied.

Figma REST API Service
Design collaboration and file API Service type
https://api.figma.com/ Base URL

What This Port Does

  • Fetch a Figma file using an explicit file key and bounded query parameters.
  • Get comments for a Figma file using an explicit file key.
  • List Figma projects for a specific team using an explicit team ID.
  • Keeps service credentials local to Harbor Node so approval, execution, and audit stay inside the Harbor ecosystem.

Operator Setup

  • Create or confirm a Figma account, team, or workspace with the API access needed for the actions you plan to enable.
  • Import this Hub entry into Harbor, then verify the service base URL and connection settings before testing actions.
  • Store the required token locally in Harbor Node using the X-Figma-Token header, then review endpoint scopes before publish.
  • Use the vendor setup guide linked below to create a personal access token or review OAuth scope requirements that match your Harbor policy.

Install

Use in Harbor UI or the import-by-URL route.
https://hub.breakwaterharbor.net/p/figma/figma-rest-api
http_api Local shell
3 Actions
Community Required tier
Never Secrets imported

Actions

Get File JSON

{
  "slug": "get-file",
  "label": "Get File",
  "description": "Fetch a Figma file using an explicit file key and bounded query parameters.",
  "method": "GET",
  "path": "/v1/files/{file_key}",
  "inputs": {
    "parameters": [
      {
        "name": "file_key",
        "in": "path",
        "required": true,
        "schema": {
          "type": "string",
          "minLength": 1
        },
        "description": "Figma file key."
      },
      {
        "name": "version",
        "in": "query",
        "schema": {
          "type": "string"
        },
        "description": "Optional specific version ID to retrieve."
      },
      {
        "name": "depth",
        "in": "query",
        "schema": {
          "type": "integer",
          "minimum": 1
        },
        "description": "Optional maximum depth into the document tree."
      },
      {
        "name": "branch_data",
        "in": "query",
        "schema": {
          "type": "boolean"
        },
        "description": "Whether to include branch metadata for the requested file."
      }
    ]
  },
  "approvalMode": "automatic",
  "requestBodyMode": "none",
  "resultMode": "json_summary"
}