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.
README
Embedded directly from the package source.
figma
@utdk/figma is a generated, typed client for this provider.
This client wraps the provider API in typed methods focused on Webhooks, Files, Library Analytics, Dev Resources.
Quick start
import figma from "@utdk/figma";
// Example operation call (see guides below for full signatures)
await figma.someOperation({});
Capability guides
- Activity Logs - 1 operations
- Comment Reactions - 3 operations
- Comments - 3 operations
- Component Sets - 3 operations
- Components - 3 operations
- Dev Resources - 4 operations
- Files - 6 operations
- Library Analytics - 6 operations
- OEmbed - 1 operations
- Payments - 1 operations
- Projects - 2 operations
- Styles - 3 operations
- Users - 1 operations
- Variables - 3 operations
- Webhooks - 7 operations
Each guide is organized by callable operation name (for example, client.someOperation), with typed input/output snippets.
Source Index
figma docs cache index
Generated: 2026-04-08T15:33:58.629Z
Sources
reference
- Registry Documentation (openapi)
- Terms of Service (openapi)
Operations
47 operations —
open try-it console
| Method | Operation ID | Path | Summary | |
|---|---|---|---|---|
| GET | getFile | /v1/files/{file_key} | Get file JSON | Try |
| GET | getFileNodes | /v1/files/{file_key}/nodes | Get file JSON for specific nodes | Try |
| GET | getImages | /v1/images/{file_key} | Render images of file nodes | Try |
| GET | getImageFills | /v1/files/{file_key}/images | Get image fills | Try |
| GET | getFileMeta | /v1/files/{file_key}/meta | Get file metadata | Try |
| GET | getTeamProjects | /v1/teams/{team_id}/projects | Get projects in a team | Try |
| GET | getProjectFiles | /v1/projects/{project_id}/files | Get files in a project | Try |
| GET | getFileVersions | /v1/files/{file_key}/versions | Get versions of a file | Try |
| GET | getComments | /v1/files/{file_key}/comments | Get comments in a file | Try |
| POST | postComment | /v1/files/{file_key}/comments | Add a comment to a file | Try |
| DELETE | deleteComment | /v1/files/{file_key}/comments/{comment_id} | Delete a comment | Try |
| GET | getCommentReactions | /v1/files/{file_key}/comments/{comment_id}/reactions | Get reactions for a comment | Try |
| POST | postCommentReaction | /v1/files/{file_key}/comments/{comment_id}/reactions | Add a reaction to a comment | Try |
| DELETE | deleteCommentReaction | /v1/files/{file_key}/comments/{comment_id}/reactions | Delete a reaction | Try |
| GET | getMe | /v1/me | Get current user | Try |
| GET | getTeamComponents | /v1/teams/{team_id}/components | Get team components | Try |
| GET | getFileComponents | /v1/files/{file_key}/components | Get file components | Try |
| GET | getComponent | /v1/components/{key} | Get component | Try |
| GET | getTeamComponentSets | /v1/teams/{team_id}/component_sets | Get team component sets | Try |
| GET | getFileComponentSets | /v1/files/{file_key}/component_sets | Get file component sets | Try |
| GET | getComponentSet | /v1/component_sets/{key} | Get component set | Try |
| GET | getTeamStyles | /v1/teams/{team_id}/styles | Get team styles | Try |
| GET | getFileStyles | /v1/files/{file_key}/styles | Get file styles | Try |
| GET | getStyle | /v1/styles/{key} | Get style | Try |
| GET | getWebhooks | /v2/webhooks | Get webhooks by context or plan | Try |
| POST | postWebhook | /v2/webhooks | Create a webhook | Try |
| GET | getWebhook | /v2/webhooks/{webhook_id} | Get a webhook | Try |
| PUT | putWebhook | /v2/webhooks/{webhook_id} | Update a webhook | Try |
| DELETE | deleteWebhook | /v2/webhooks/{webhook_id} | Delete a webhook | Try |
| GET | getTeamWebhooks | /v2/teams/{team_id}/webhooks | [Deprecated] Get team webhooks | Try |
| GET | getWebhookRequests | /v2/webhooks/{webhook_id}/requests | Get webhook requests | Try |
| GET | getActivityLogs | /v1/activity_logs | Get activity logs | Try |
| GET | getPayments | /v1/payments | Get payments | Try |
| GET | getLocalVariables | /v1/files/{file_key}/variables/local | Get local variables | Try |
| GET | getPublishedVariables | /v1/files/{file_key}/variables/published | Get published variables | Try |
| POST | postVariables | /v1/files/{file_key}/variables | Create/modify/delete variables | Try |
| GET | getDevResources | /v1/files/{file_key}/dev_resources | Get dev resources | Try |
| POST | postDevResources | /v1/dev_resources | Create dev resources | Try |
| PUT | putDevResources | /v1/dev_resources | Update dev resources | Try |
| DELETE | deleteDevResource | /v1/files/{file_key}/dev_resources/{dev_resource_id} | Delete dev resource | Try |
| GET | getLibraryAnalyticsComponentActions | /v1/analytics/libraries/{file_key}/component/actions | Get library analytics component action data. | Try |
| GET | getLibraryAnalyticsComponentUsages | /v1/analytics/libraries/{file_key}/component/usages | Get library analytics component usage data. | Try |
| GET | getLibraryAnalyticsStyleActions | /v1/analytics/libraries/{file_key}/style/actions | Get library analytics style action data. | Try |
| GET | getLibraryAnalyticsStyleUsages | /v1/analytics/libraries/{file_key}/style/usages | Get library analytics style usage data. | Try |
| GET | getLibraryAnalyticsVariableActions | /v1/analytics/libraries/{file_key}/variable/actions | Get library analytics variable action data. | Try |
| GET | getLibraryAnalyticsVariableUsages | /v1/analytics/libraries/{file_key}/variable/usages | Get library analytics variable usage data. | Try |
| GET | getOEmbed | /v1/oembed | Get oEmbed data | Try |