Components

Export components

Returns components in your workspace in the provided format.

get/components/export

Request

  • Base URL: https://api.dittowords.com/v2
  • URL: https://api.dittowords.com/v2/components/export
  • Auth: API key in header Authorization

Query parameters

filterstring

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'html' | 'html_paragraphs'

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.
variantIdstring

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

format'json_icu' | 'json_i18next' | 'json_vue_i18n' | 'ios-strings' | 'ios-stringsdict' | 'android' | 'arb' required

Output format for exported components.

variableSort'default' | 'alphabetical'

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.

'true'
OR
'false'
'true'
OR
'false'

Response

Returns components matching the filter criteria in the provided format

object required

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.

Example response

{
  "@@locale": "en",
  "component-item-dev-id": "<em>Some other</em> text",
  "component-item-dev-id-2": "Some <strong>base</strong> text",
  "@component-item-dev-id-2": {
    "placeholders": {
      "username": {
        "type": "String"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.