Skip to main content
GET
/
textItems
/
export
Export text items
curl --request GET \
  --url https://api.dittowords.com/v2/textItems/export \
  --header 'Authorization: <api-key>'
{
  "user-account-header": "{{FullName}}'s Account",
  "user-account-settings-label": "Account Settings",
  "user-account-settings-payment-header": "Payment Details",
  "welcome-header": "Welcome to Acme Inc., {{FirstName}}",
  "no-notifications-label": "No new notifications"
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
format
enum<string>
required

Format that text items 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 text items 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 projects (array of project IDs) and/or statuses (array of status names). Note: If both the status filter and variantId param are provided, variant statuses must match the status filter in addition to their base status matching the status filter to be returned.

Example: `{"projects":[{"id":"project-id"}],"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 text item developer id - text item value key/value pairs in the desired 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