API: Export translations (v3)

Last updated: September 23, 2024Author: Jakub Pomykała

Export translations to downloadable file. Using this endpoint requires authorization.

Deprecated

This endpoint has been replaced by a version 4 that supports more options. Please use v4 export endpoint instead. At the moment, the v3 endpoint is still available, and there is no plan to remove it. However, it is recommended to use the v4 endpoint.

Endpoint

GET
https://api.simplelocalize.io
/api/v3/export

Sample requests

Download all translations into one file

curl
  --request GET \
  --url https://api.simplelocalize.io/api/v3/export?downloadFormat=multi-language-json \
  --header 'x-simplelocalize-token: <API_KEY>'

Learn more about multi-language-json.

Download translations for one language

curl
  --request GET \
  --url https://api.simplelocalize.io/api/v3/export?downloadFormat=single-language-json&languageKey=en \
  --header 'x-simplelocalize-token: <API_KEY>'

Learn more about single-language-json.

Query parameters

ParameterDescription
downloadFormat(required) See all available download formats
exportOptions(optional) See all available export options
languageKey(optional) Set the language key if you want to export translations just for one language
customerId(optional) Set the customer id if you would like to export just customer translations

Successful response

{
    "msg": "OK",
    "status": 200,
    "data": {
        "url": "https://cdn.simplelocalize.io/29fdc3462/snapshot_2021-10-12_13-01-25_063/translations.json"
    }
}
Was this helpful?