Aprovan Registry
provider 47 operations 15 docs pages
@utdk/figma
Figma API

Generated UTDK provider client for Figma API. This is the OpenAPI specification for the Figma REST API.

Note: we are releasing the OpenAPI specification as a beta given the large surface area and complexity of the REST API. If you notice any inaccuracies with the specification, please file an issue.

Import sample

import figma from "@utdk/figma"

Factory sample

import { createFigmaClient } from "@utdk/figma"
Provider path
figma
Source API title
Figma API
Version
0.37.0
Generated
Apr 8, 2026, 3:35 PM
Homepage
Open site
API spec
View spec
Comment Reactions
Optional generated docs page for @utdk/figma.

Comment Reactions

Use these operations through the generated client (not direct HTTP calls).

Import path: @utdk/figma

Operations

figma.deleteCommentReaction

  • HTTP: DELETE /v1/files/{file_key}/comments/{comment_id}/reactions
  • What it does: Delete a reaction
  • OpenAPI operationId: deleteCommentReaction
  • Path params: file_key, comment_id
  • Query params: emoji
  • Response codes: 200, 403, 404, 429, 500
  • Transport options: None
  • Source: OpenAPI reference
  • TypeScript: Client interface

Inputs

  • Client input type: { file_key: string; comment_id: string; emoji: string }
  • Client transport options: None

Outputs

  • Client return type: { status: 200; error: false }
  • OpenAPI response codes: 200, 403, 404, 429, 500
import figma from "@utdk/figma";

type DeleteCommentReactionInput = Parameters<typeof figma.deleteCommentReaction> extends [infer T, ...unknown[]] ? T : undefined;
type DeleteCommentReactionOutput = Awaited<ReturnType<typeof figma.deleteCommentReaction>>;

const input: DeleteCommentReactionInput = {} as { file_key: string; comment_id: string; emoji: string };
const result: DeleteCommentReactionOutput = await figma.deleteCommentReaction(input);

// Result shape (from schema): { status: 200; error: false }

figma.getCommentReactions

  • HTTP: GET /v1/files/{file_key}/comments/{comment_id}/reactions
  • What it does: Get reactions for a comment
  • OpenAPI operationId: getCommentReactions
  • Path params: file_key, comment_id
  • Query params: cursor
  • Response codes: 200, 403, 404, 429, 500
  • Transport options: None
  • Source: OpenAPI reference
  • TypeScript: Client interface

Inputs

  • Client input type: { file_key: string; comment_id: string; cursor?: string }
  • Client transport options: None

Outputs

  • Client return type: { reactions: ({ user: { id: string; handle: string; img_url: string }; emoji: string; created_at: string })[]; pagination: { prev_page?: string; next_page?: string } }
  • OpenAPI response codes: 200, 403, 404, 429, 500
import figma from "@utdk/figma";

type GetCommentReactionsInput = Parameters<typeof figma.getCommentReactions> extends [infer T, ...unknown[]] ? T : undefined;
type GetCommentReactionsOutput = Awaited<ReturnType<typeof figma.getCommentReactions>>;

const input: GetCommentReactionsInput = {} as { file_key: string; comment_id: string; cursor?: string };
const result: GetCommentReactionsOutput = await figma.getCommentReactions(input);

// Result shape (from schema): { reactions: ({ user: { id: string; handle: string; img_url: string }; emoji: string; created_at: string })[]; pagination: { prev_page?: string; next_page?: string } }

figma.postCommentReaction

  • HTTP: POST /v1/files/{file_key}/comments/{comment_id}/reactions
  • What it does: Add a reaction to a comment
  • OpenAPI operationId: postCommentReaction
  • Path params: file_key, comment_id
  • Query params: None
  • Response codes: 200, 400, 403, 404, 429, 500
  • Transport options: None
  • Source: OpenAPI reference
  • TypeScript: Client interface

Inputs

  • Client input type: { emoji: string; file_key: string; comment_id: string }
  • Client transport options: None

Outputs

  • Client return type: { status: 200; error: false }
  • OpenAPI response codes: 200, 400, 403, 404, 429, 500
import figma from "@utdk/figma";

type PostCommentReactionInput = Parameters<typeof figma.postCommentReaction> extends [infer T, ...unknown[]] ? T : undefined;
type PostCommentReactionOutput = Awaited<ReturnType<typeof figma.postCommentReaction>>;

const input: PostCommentReactionInput = {} as { emoji: string; file_key: string; comment_id: string };
const result: PostCommentReactionOutput = await figma.postCommentReaction(input);

// Result shape (from schema): { status: 200; error: false }