Actions43
- Comment Actions
- Component and Style Actions
- Dev Resource Actions
- Figma File Actions
- Library Analytic Actions
- Project Actions
- User Actions
- Variable Actions
- Version History Actions
- Webhook V2 Actions
Component and Style → List File Components
AI-generatedSummary
List published components within a specific Figma file, optionally filtering and paginating the results through various query parameters.
Inputs
- File Key (required) — The unique key identifying the Figma file from which to list the components.
- Query Parameters — Optional parameters to filter, paginate, and customize the returned list of components, such as pagination cursors (after, before, cursor), limits on the number of results, version specification, and other advanced filtering options.
Output shape
a JSON object containing the list of published components in the specified Figma file, including component metadata and pagination information if applicable.
The operation returns data as provided by the Figma API endpoint for listing file components. Pagination can be managed using 'cursor', 'after', 'before', and 'limit' query parameters. Providing an invalid or missing File Key will result in an error.
Examples
Example 1: List up to 50 components from a Figma file with a given File Key.
Set 'File Key' to the target Figma file's key and optionally set 'Limit' within query parameters to control the number of results returned.