Skip to main content
GET
/
components
/
export
Export components
curl --request GET \
  --url https://api.dittowords.com/v2/components/export \
  --header 'Authorization: <api-key>'
{
  "component-item-dev-id": "<em>Some other</em> text",
  "component-item-dev-id-2": "Some <strong>base</strong> text"
}

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)
  • 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', includes HTML-formatted rich text in the response

Available options:
html
​
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

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

​
{key}
string

The text value for the developer-id key