Skip to main content
GET
Export components

Authorizations

Authorization
string
header
required

Query Parameters

filter
string

Stringified JSON filter object. Supports the following filter fields:

  • folders: array of objects with id (folder developer ID or root for root-level components) and optional excludeNestedFolders (boolean)
  • statuses: array of status strings (NONE, WIP, REVIEW, FINAL). These are stored status keys; by default the web app and Figma plugin display them as NONE = "Draft", WIP = "In Progress", REVIEW = "In Review", FINAL = "Final" (a workspace may rename these or replace the set entirely, so none of these keys are guaranteed to exist — read the workspace's actual statuses from GET /v2/statuses or the list_statuses MCP tool rather than assuming this set).
  • tags: object with values (array of tag strings) and optional operator (AND or OR, defaults to OR)
  • assignee: email string to match assigned components, or null for unassigned
  • integrated: boolean value to filter by components that are or are not marked as integrated into development

By default, folder filters search for components in that folder and its folder children. To skip searching folder children for a given folder, set excludeNestedFolders to true.

Example: {"folders":[{"id":"folder-id"},{"id":"folder-id-2","excludeNestedFolders":true}], "statuses":["NONE","WIP","FINAL","REVIEW"], "tags":{"values":["tag-1"],"operator":"OR"}, "assignee":"user@example.com", "integrated":true}

richText
enum<string>

When set to html or html_paragraphs, returns HTML-formatted rich text instead of plain text.

  • html_paragraphs wraps all text in <p> tags. Matches legacy behavior.
  • html exports without wrapping tags and uses <br /> for line breaks.
Available options:
html,
html_paragraphs
variantId
string

By default, base text will be returned. Provide a variant parameter to specify which variant of the filtered base text items to return.

format
enum<string>
required

Output format for exported components.

Available options:
json_icu,
json_i18next,
json_vue_i18n,
ios-strings,
ios-stringsdict,
android,
arb
variableSort
enum<string>

Order in which variables are indexed in positional format exports (ios-strings, ios-stringsdict, android). "alphabetical" assigns indices by variable name (a=1, b=2, ...); "default" preserves the existing creation-order assignment.

Available options:
default,
alphabetical
excludeVariantMetadata

When true, omits the __variant-name and __variant-description keys from variant exports in JSON formats (json_i18next, json_vue_i18n, json_icu). Defaults to false. Has no effect on any other formats nor any base text (non-variant) exports, which never include these keys.

Available options:
true
includeVariableSummary

When true, adds a __variables_used key to json_i18next and json_vue_i18n exports: a deduplicated, alphabetical array of the names of the variables used in the exported strings. Defaults to false. Has no effect on other formats.

Available options:
true

Response

Returns components matching the filter criteria in the provided format

For json_icu, json_i18next, json_vue_i18n formats, object keys are developer-ids (strings) and values are text (strings). Variant exports in these formats also include __variant-name and __variant-description keys (strings) unless excludeVariantMetadata=true. When includeVariableSummary=true, json_i18next and json_vue_i18n exports also include a __variables_used key, whose value is an array of variable names. For arb, values are text (strings) except for the optional top-level @@locale key (string) and @<developer-id> metadata keys, which are objects.

{key}

The text value for the developer-id key, the __variant-name/__variant-description value for variant exports, or the @@locale value for arb exports