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

​
format
enum<string>
required

Format that components will be returned in.

Available options:
json_icu,
json_i18next,
json_vue_i18n,
android,
ios-strings,
ios-stringsdict
​
variantId
string

Variant developer ID, corresponding to which variant of the filtered base components to return. If not provided, will return base variant text. A variant's developer ID can be found on its definition at https://app.dittowords.com/variants. e.g. spanish.

​
filter
string

Stringified JSON filter object. Can filter by folders (array of folder IDs or 'root' for root-level components) and/or statuses (array of status names). If statuses are provided in conjunction with the variantId query param, variant statuses must match the status filter in addition to their base status matching the status filter to be returned. 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"]}

​
richText
enum<string>

When set to 'html', includes HTML-formatted rich text in the response

Available options:
html

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