Figma

Parámetros de entrada

• messagestringObligatorio

  Text content of the comment.

• file_keystringObligatorio

  Identifier for the Figma file or branch. Can be a file key or a branch key (use `GET /v1/files/:key` with `branch_data` to get a branch key).

• comment_idstring

  ID of an existing root comment to reply to. Replies cannot be made to other replies.

• client_metaobject

  Optional. Dictionary specifying the comment's position (e.g., absolute canvas coordinates, relative to a node, or a region defined with dimensions and positioning). If omitted, Figma determines a default position.

Parámetros de salida

• dataobjectObligatorio

  Full details of the successfully posted comment.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emojistringObligatorio

  The emoji to use for the reaction, specified as a shortcode (e.g., `:heart:`, `:+1::skin-tone-2:`). For a comprehensive list of accepted emoji shortcodes, including aliases and skin tone modifiers, refer to the file linked here: [https://raw.githubusercontent.com/missive/emoji-mart/main/packages/emoji-mart-data/sets/14/native.json](https://raw.githubusercontent.com/missive/emoji-mart/main/packages/emoji-mart-data/sets/14/native.json).

• file_keystringObligatorio

  Identifier of the Figma file or branch to which the comment reaction will be posted. This can be a file key (e.g., from the file URL) or a branch key. Use the `GET /v1/files/:key` endpoint with the `branch_data=true` query parameter to obtain the branch key if needed.

• comment_idstringObligatorio

  The unique identifier of the comment to which the reaction should be added.

Parámetros de salida

• dataobjectObligatorio

  Contains the response data from the API, typically including the status of the operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• statusstringenum

  Initial status. `VAL_ACTIVE` (default): webhook is operational and receives initial `PING`. `VAL_PAUSED`: webhook is inactive, no initial `PING`; requires later activation to receive events.

  ACTIVEPAUSED
• team_idstringObligatorio

  Identifier of the Figma team for which this webhook monitors events.

• endpointstringObligatorio

  Publicly accessible HTTPS URL (max 2048 chars) that receives POST requests from Figma for the `event_type`.

• passcodestringObligatorio

  Secret string (max 100 chars) included in requests to your `endpoint` for verifying Figma's origin.

• event_typestringObligatorioenum

  Type of event that triggers the webhook.

  FILE_COMMENTFILE_DELETEFILE_UPDATEFILE_VERSION_UPDATELIBRARY_PUBLISHPING
• descriptionstring

  Optional user-defined description for the webhook (max 150 chars), useful for identification and management.

Parámetros de salida

• dataobjectObligatorio

  Full details of the successfully created webhook.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• dev_resourcesobject[]Obligatorio

  List of development resources to create.

Parámetros de salida

• dataobjectObligatorio

  Successfully created dev resources and any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  The key of the Figma file or branch to modify variables in. Use `GET /v1/files/:key` with the `branch_data=true` query parameter to obtain a branch key.

• variablesobject[]

  List of operations for variables, each a dict with 'action' ('CREATE', 'UPDATE', 'DELETE'). For 'CREATE', include 'variableCollectionId', 'name', 'resolvedType' (temp 'id' optional). For 'UPDATE', 'id' and fields to modify. For 'DELETE', 'id'. See Figma API's `VariableMutation` for details.

• variableModesobject[]

  List of operations for modes, each a dict with 'action' ('CREATE', 'UPDATE', 'DELETE'). For 'CREATE', include 'variableCollectionId', 'name' (temp 'id' optional). For 'UPDATE', 'id' and 'name'. For 'DELETE', 'id'. See Figma API's `VariableModeMutation` for details.

• variableModeValuesobject[]

  A list of specific values to set for variables in particular modes. Each item links a variable and a mode to a new value.

• variableCollectionsobject[]

  List of operations for variable collections, each a dict with 'action' ('CREATE', 'UPDATE', 'DELETE'). For 'CREATE', include 'name' (temp 'id' optional). For 'UPDATE', 'id' and fields to modify. For 'DELETE', 'id'. See Figma API's `VariableCollectionMutation` for details.

Parámetros de salida

• dataobjectObligatorio

  The main part of the response, containing status, error indication, and metadata from the operation.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  The key of the Figma file or branch from which the comment will be deleted. This can be a file key (typically found in the file's URL) or a branch key. To obtain a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data` query parameter.

• comment_idstringObligatorio

  The unique string identifier of the comment to be deleted. This ID is specific to the comment within the Figma file.

Parámetros de salida

• dataobjectObligatorio

  Contains the outcome of the comment deletion attempt, including status and error indicators.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• emojistringObligatorio

  The specific emoji character (e.g., '❤️', '👍') of the reaction to delete. This must be an exact match to the emoji of an existing reaction on the comment.

• file_keystringObligatorio

  Key of the file or branch containing the comment reaction to be deleted. The file key can be obtained from the file URL or API responses. To get a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data` query parameter.

• comment_idstringObligatorio

  Identifier of the comment from which the reaction will be removed. This ID is specific to the comment within the Figma file.

Parámetros de salida

• dataobjectObligatorio

  Contains the result of the delete operation, including status and error information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhook_idstringObligatorio

  The unique identifier of the webhook to be deleted.

Parámetros de salida

• dataobjectObligatorio

  Contains the details of the webhook that was successfully deleted.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Identifier of the Figma file from which to delete the dev resource. Must be a main file key, not a branch key.

• dev_resource_idstringObligatorio

  Identifier of the dev resource to delete from the file.

Parámetros de salida

• dataobjectObligatorio

  API response dictionary; typically an empty object confirms successful deletion.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• prefixstring

  Prefix for generated token names (e.g., 'brand-')

• tokensobjectObligatorio

  Design tokens to convert

• config_formatstring

  Output format: 'ts' for TypeScript or 'js' for JavaScript

• include_font_importsboolean

  Include @import statements for Google Fonts

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  The Figma file key

• search_depthinteger

  How many levels up to search for backgrounds

• target_node_idsstring[]Obligatorio

  List of node IDs to find backgrounds for

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstring

  Team ID to list all projects from. Get this from team URL: https://www.figma.com/files/team/YOUR_TEAM_ID/Team-Name. Returns list of projects with IDs and names.

• file_keystring

  File key to extract all node IDs from. Get this from file URL (figma.com/file/FILE_KEY/...) or from project files list. Returns hierarchical list of all nodes with IDs, names, types, and paths.

• figma_urlstring

  Full Figma URL to extract file_key, node_id, and team_id from. Works with any Figma URL format: • File: https://www.figma.com/file/ABC123/Design-Name • Design: https://www.figma.com/design/ABC123/Design-Name • With node: https://www.figma.com/file/ABC123/Design?node-id=123:456 • Team: https://www.figma.com/files/team/123456/Team-Name This is the easiest way to get all IDs you need!

• max_depthinteger

  Maximum tree depth to traverse when discovering nodes. 2=pages+frames, 3=pages+frames+components, etc. Higher values find more nodes but take longer.

• project_idstring

  Project ID to list all files from. Get this from project URL or from team projects list. Returns files with keys, names, and thumbnails.

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• scalenumber

  Image scaling factor (0.01 to 4, default 2 for retina)

• imagesobject[]Obligatorio

  List of images to download

• file_keystringObligatorio

  Figma file key from URL

• svg_include_idboolean

  Include element IDs in SVG

• svg_outline_textboolean

  Convert text to paths in SVG for accuracy

• svg_simplify_strokeboolean

  Simplify strokes in SVG

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  The Figma file key

• include_variablesboolean

  Include variables in extraction

• extract_from_nodesboolean

  Extract tokens from node properties

• include_local_stylesboolean

  Include local styles in extraction

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Figma file key from URL

• analyze_componentsboolean

  Extract component variant states

• include_animationsboolean

  Include detailed animation data

Parámetros de salida

• dataobjectObligatorio

  Data from the action execution

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• limitinteger

  Maximum number of events per response, for pagination. If unspecified, defaults to 1000.

• orderstringenum

  Sort order for events by timestamp.

  ascdesc
• eventsstring

  Comma-separated event types to include. If unspecified, all event types are returned. Refer to Figma's API documentation for a comprehensive list.

• end_timeinteger

  Unix timestamp for the latest time for events. If unspecified, defaults to the current timestamp.

• start_timeinteger

  Unix timestamp for the earliest time for events. If unspecified, defaults to one year ago.

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhook_idstringObligatorio

  The unique identifier of the webhook to retrieve.

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed information of the retrieved webhook.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• as_mdboolean

  If true, comment content will be returned in Markdown format where applicable (e.g., for links, bold text). Defaults to false, returning rich text structure.

• file_keystringObligatorio

  Identifier for the Figma file from which to retrieve comments. This can be a file key (a unique string identifying a file) or a branch key. To obtain a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data` query parameter.

Parámetros de salida

• dataobjectObligatorio

  Wrapper object containing the list of comments.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• node_idstringObligatorio

  ID of the component node

• file_keystringObligatorio

  File key that contains the component

• simplifyboolean

  Automatically simplify response (recommended)

Parámetros de salida

• dataobjectObligatorio
• errorstring

  Error if any occurred during the execution of the action

• simplifiedbooleanObligatorio
• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• keystringObligatorio

  The unique identifier of the component set.

Parámetros de salida

• dataobjectObligatorio

  The main data payload of the response, containing details of the component set.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

Sin parámetros.

Parámetros de salida

• dataobjectObligatorio

  Detailed information of the currently authenticated user.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  The unique identifier of the Figma design file from which to retrieve development resources. This must be the key for a main file, not a branch key.

• node_idsstring

  A comma-separated string of node IDs. If provided, the response will be filtered to include only development resources linked to these specific nodes. If omitted or `null`, all development resources in the file will be returned.

Parámetros de salida

• dataobjectObligatorio

  The object containing the list of development resources.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Key of the Figma file. This file must be a main file (not a branch key) that acts as a library, as components are published from main files.

Parámetros de salida

• dataobjectObligatorio

  Structured API response detailing retrieved components and request outcome.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Key of the Figma file. Must be a main file key (not a branch key) as component sets are published from main files.

Parámetros de salida

• dataobjectObligatorio

  The structured response data from the API, including status, error information, and the list of component sets.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstring

  Comma-separated node IDs to fetch specific nodes

• depthinteger

  Tree traversal depth (e.g., 2 for pages and top-level children)

• versionstring

  Specific version ID; current version if omitted

• file_keystringObligatorio

  Figma file key from URL (figma.com/file/{file_key}/...)

• geometrystring

  Set to "paths" to include vector data

• simplifyboolean

  Automatically simplify response for AI (recommended)

• branch_databoolean

  Include branch metadata

• include_rawboolean

  Include raw API response alongside simplified data

• plugin_datastring

  Comma-separated plugin IDs to include plugin data

Parámetros de salida

• dataobjectObligatorio

  Simplified Figma file data (or raw if simplify=False)

• errorstring

  Error if any occurred during the execution of the action

• raw_dataobject

  Raw API response (only if include_raw=True)

• simplifiedbooleanObligatorio

  Whether the data was simplified

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• project_idstringObligatorio

  Identifier of the Figma project, typically found in its URL.

• branch_databoolean

  If true, includes metadata for branches of main files.

Parámetros de salida

• dataobjectObligatorio

  Contains the project's details, including its name and a list of its associated files.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Key of the main Figma file (not a branch) from which to retrieve styles.

Parámetros de salida

• dataobjectObligatorio

  Structured response data.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Identifier of the Figma file or branch from which to retrieve image fill URLs. This can be a file key (obtained from the file's URL) or a branch key.

Parámetros de salida

• dataobjectObligatorio

  Contains the mapping of image references to their download URLs, along with response status information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  Opaque cursor for pagination, from a previous response's `cursor` field; omit for the first page.

• end_datestring

  End date (YYYY-MM-DD) for analytics. Data includes up to end of this date's week. Defaults to latest computed week.

• file_keystringObligatorio

  Unique identifier (key) of the Figma library file to retrieve analytics data from.

• group_bystringObligatorioenum

  Dimension to group analytics: 'component' or 'team'.

  componentteam
• start_datestring

  Start date (YYYY-MM-DD) for analytics. Data includes from start of this date's week. Defaults to one year prior.

Parámetros de salida

• dataobjectObligatorio

  The structured library analytics data.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  Opaque string for pagination to fetch the next page of data, obtained from a previous response.

• file_keystringObligatorio

  Unique identifier (key) of the Figma library file.

• group_bystringObligatorioenum

  Dimension to group analytics data, affecting the response `rows` structure.

  componentfile

Parámetros de salida

• dataobjectObligatorio

  The analytics results, including usage rows and pagination information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  Opaque cursor for pagination, from a previous response's `cursor` field to fetch the next page; omit for first page.

• end_datestring

  End date for the analytics data range (YYYY-MM-DD). Data includes up to the end of this date's week. Defaults to the most recently computed week if unspecified.

• file_keystringObligatorio

  Unique identifier (key) of the Figma library.

• group_bystringObligatorioenum

  Dimension by which to group the library style analytics data.

  styleteam
• start_datestring

  Start date for the analytics data range (YYYY-MM-DD). Data includes from the start of this date's week. Defaults to one year prior if unspecified.

Parámetros de salida

• dataobjectObligatorio

  Structured analytics data, including rows, `next_page` flag, and `cursor` for pagination if applicable.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  An opaque string cursor from a previous response, used for paginating through results. If not provided, the first page is returned.

• file_keystringObligatorio

  The unique key of the Figma library for which to retrieve style usage analytics.

• group_bystringObligatorioenum

  Dimension by which to group analytics data, determining the structure of 'rows' in the response.

  filestyle

Parámetros de salida

• dataobjectObligatorio

  Contains the structured analytics data, pagination information, and the actual usage rows.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  Opaque cursor for pagination from a previous response; omit or use null for the first page.

• end_datestring

  End date (YYYY-MM-DD) for the analytics range. Data is aggregated weekly; this date rounds to the nearest week end. Defaults to the latest computed week if unspecified.

• file_keystringObligatorio

  Unique identifier (key) of the Figma file (library) for which to retrieve variable analytics data.

• group_bystringObligatorioenum

  Dimension to group analytics data, which determines the structure of `rows` in the response.

  teamvariable
• start_datestring

  Start date (YYYY-MM-DD) for the analytics range. Data is aggregated weekly; this date rounds to the nearest week start. Defaults to one year prior if unspecified.

Parámetros de salida

• dataobjectObligatorio

  Structured response with paginated library analytics data for variable actions.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  Opaque cursor for pagination, from a previous response's `cursor` field if `next_page` was true. Omit for the first page.

• file_keystringObligatorio

  Key of the Figma library file (from its URL) for which to retrieve variable usage analytics.

• group_bystringObligatorioenum

  Dimension for grouping analytics data, determining the structure of `rows` in the response ('file' or 'variable').

  filevariable

Parámetros de salida

• dataobjectObligatorio

  Paginated analytics data for variable usage from the specified library.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  Key of the Figma file or branch. Can be a standard file key or a branch-specific key (to obtain a branch key, use `GET /v1/files/:key` with the `branch_data` query parameter).

Parámetros de salida

• dataobjectObligatorio

  The structured response data containing the status, error indicator, and the local variables metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• user_idinteger

  ID of the user whose payment information is sought. Obtain via OAuth2 with Figma REST API. Required if `plugin_payment_token` is not provided.

• plugin_idinteger

  ID of the plugin. Obtain from its manifest or Community page URL (number after 'plugin/'). If `user_id` is provided, specify exactly one of `community_file_id`, `plugin_id`, or `widget_id`.

• widget_idinteger

  ID of the widget. Obtain from its manifest or Community page URL (number after 'widget/'). If `user_id` is provided, specify exactly one of `community_file_id`, `plugin_id`, or `widget_id`.

• community_file_idinteger

  ID of the Community file. Obtain from its Community page URL (number after 'file/'). If `user_id` is provided, specify exactly one of `community_file_id`, `plugin_id`, or `widget_id`.

• plugin_payment_tokenstring

  Short-lived auth token from `getPluginPaymentTokenAsync` (Figma Plugin Payments API). See Figma docs 'Calling the Payments REST API...'. If provided, `user_id` and resource IDs are typically not needed.

Parámetros de salida

• dataobjectObligatorio

  Contains the detailed payment information for the user and resource, including status, error, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstringObligatorio

  Identifier of the Figma team from which to list projects. Note: The `team_id` cannot be programmatically obtained solely from a user token. To find a `team_id`, navigate to a team page you are a member of in Figma. The `team_id` will be present in the URL, typically formatted as `https://www.figma.com/files/team/YOUR_TEAM_ID/Your_Team_Name`.

Parámetros de salida

• dataobjectObligatorio

  Contains the team's name and its list of associated projects.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• file_keystringObligatorio

  The key of the Figma file from which to retrieve published variables. This must be a main file's key, not a branch key, as publishing from branches is not supported.

Parámetros de salida

• dataobjectObligatorio

  The structured response data containing status, error information, and the metadata of published variables.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• cursorstring

  Pagination cursor from `next_page` of a previous response. Omit or use null for the first page.

• file_keystringObligatorio

  Key for the Figma file or branch. Can be a file key (from URL) or a branch key. To get a branch key, use `GET /v1/files/:key` with the `branch_data` query parameter.

• comment_idstringObligatorio

  Identifier of the comment.

Parámetros de salida

• dataobjectObligatorio

  Contains the list of reactions and pagination details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• keystringObligatorio

  The unique identifier (key) of the style to retrieve. Style keys are typically prefixed with 'S:'.

Parámetros de salida

• dataobjectObligatorio

  The main data payload of the response, encapsulating the style's status, error state, and metadata.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• afterinteger

  Opaque cursor indicating the point after which to retrieve components. Used for pagination. Exclusive with the `before` parameter. The cursor value is an internally tracked integer that doesn't correspond to any specific Figma IDs.

• beforeinteger

  Opaque cursor indicating the point before which to retrieve components. Used for pagination. Exclusive with the `after` parameter. The cursor value is an internally tracked integer that doesn't correspond to any specific Figma IDs.

• team_idstringObligatorio

  Identifier of the Figma team from which to retrieve published components.

• page_sizeinteger

  Number of components to return per page.

Parámetros de salida

• dataobjectObligatorio

  The main data payload of the response, including status, error indicator, and the retrieved components along with pagination cursors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• afterinteger

  Cursor for pagination, indicating the point after which to retrieve component sets. Exclusive with the 'before' parameter. The cursor value is an internally tracked integer and does not correspond to any specific Figma IDs.

• beforeinteger

  Cursor for pagination, indicating the point before which to retrieve component sets. Exclusive with the 'after' parameter. The cursor value is an internally tracked integer and does not correspond to any specific Figma IDs.

• team_idstringObligatorio

  The unique identifier of the team from which to list component sets.

• page_sizeinteger

  Number of component sets to return in a single page.

Parámetros de salida

• dataobjectObligatorio

  The structured response from the API, containing the status, error indicator, and the metadata which includes component sets and pagination cursors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• afterinteger

  Opaque integer cursor to retrieve styles after this point; use `cursor.after` from a previous response. Exclusive with `before`.

• beforeinteger

  Opaque integer cursor to retrieve styles before this point; use `cursor.before` from a previous response. Exclusive with `after`.

• team_idstringObligatorio

  Identifier of the team to retrieve published styles from.

• page_sizeinteger

  Number of style items to return per page.

Parámetros de salida

• dataobjectObligatorio

  The main container for the response, including status, error indication, and the metadata which holds the styles and pagination cursors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• team_idstringObligatorio

  Identifier of the team for which to retrieve webhooks.

Parámetros de salida

• dataobjectObligatorio

  An object containing the list of webhooks for the team.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• afterinteger

  Version ID for pagination; retrieves versions created strictly after this ID.

• beforeinteger

  Version ID for pagination; retrieves versions created strictly before this ID.

• file_keystringObligatorio

  The key of the file or branch from which to retrieve the version history. For branch keys, use `GET /v1/files/:key` with the `branch_data` query param to obtain it.

• page_sizeinteger

  Number of version items per page. The API defaults to 30 if this parameter is not sent.

Parámetros de salida

• dataobjectObligatorio

  The main response data, containing the list of file versions and pagination information.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• webhook_idstringObligatorio

  The unique identifier of the Figma webhook subscription for which to retrieve past event requests. This refers to the ID of the webhook itself, not an individual event.

Parámetros de salida

• dataobjectObligatorio

  Contains the list of webhook requests detailing past event deliveries for the specified webhook.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• idsstringObligatorio

  Comma-separated list of node IDs to render as images (e.g., '1:2,1:3,1:4').

• scaleinteger

  Image scaling factor, a number between 0.01 and 4 (e.g., 2 renders at twice original size).

• formatstringenum

  Desired output format for the rendered images.

  jpgpdfpngsvg
• versionstring

  Specific version ID of the file to render; if omitted, the current version is used.

• file_keystringObligatorio

  Key of the Figma file or branch. To obtain a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data=true` query parameter.

• contents_onlyboolean

  If true, excludes content overlapping node boundaries. If false, includes overlapping content (may increase processing time).

• svg_include_idboolean

  (SVG format only) If true, includes `id` attributes (using layer name) for all SVG elements.

• svg_outline_textboolean

  (SVG format only) If true, text is rendered as vector paths (outlines) for visual fidelity. If false, text is rendered as `<text>` elements (selectable, appearance may vary).

• svg_include_node_idboolean

  (SVG format only) If true, includes `data-node-id` attribute (with node ID) for all SVG elements.

• svg_simplify_strokeboolean

  (SVG format only) If true, simplifies inside/outside strokes, using `stroke` attribute instead of `<mask>` where possible.

• use_absolute_boundsboolean

  If true, uses full node dimensions for rendering, ignoring cropping/empty space (useful for text nodes without unintended cropping).

Parámetros de salida

• dataobjectObligatorio

  Core response data with image rendering results.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• statusstringenum

  Operational status: `ACTIVE` to receive events, `PAUSED` to temporarily stop event delivery.

  ACTIVEPAUSED
• endpointstringObligatorio

  URL of the HTTP endpoint to receive POST requests for webhook events. Max length 2048.

• passcodestringObligatorio

  Secret string for your endpoint to verify webhook authenticity. Max length 100.

• event_typestringObligatorioenum

  Type of event that triggers the webhook.

  FILE_COMMENTFILE_DELETEFILE_UPDATEFILE_VERSION_UPDATELIBRARY_PUBLISHPING
• webhook_idstringObligatorio

  Unique identifier of the existing webhook to update.

• descriptionstring

  Optional description for the webhook. Max length 150.

Parámetros de salida

• dataobjectObligatorio

  The updated webhook object details.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not

Parámetros de entrada

• dev_resourcesobject[]Obligatorio

  List of dev resources to update. Each must include its `id` and can optionally provide a new `name` and/or `url`.

Parámetros de salida

• dataobjectObligatorio

  Detailed results of the bulk update, including successfully updated resources and any errors.

• errorstring

  Error if any occurred during the execution of the action

• successfulbooleanObligatorio

  Whether or not the action execution was successful or not