Figma icon

Figma

Use the Figma API

Variable → List Published Variables

AI-generated

Summary

List published variables from a specified Figma design file, supporting pagination and filtering through various query parameters.

Inputs

  • Key (required) — The unique file key of the Figma file from which to list published variables.
  • Query Parameters — Optional parameters to control pagination, filtering, and response details such as 'limit' (maximum results), 'cursor' (pagination cursor), 'order' (ascending or descending), 'version' (specific file version), and various other filters that affect the returned variable list.

Output shape

a list of published variables in JSON format, as returned by the Figma API for the specified file key and query parameters.

The response supports pagination via cursor-based parameters. If no published variables exist or the file key is invalid, the response may be empty or an error may be thrown. All input parameters are passed as query parameters on the API call to customize the list retrieval.

Discussion