Tolgee Octri Demo
GET/v2/projects/{projectId}/export

Export project data

Exports project data in a selected format, with optional language, key, tag, state, namespace, and branch filters. Set zip to false to return a single file, which requires exporting one language; conditional request headers can avoid transferring data that has not changed. The response is a file or a ZIP archive containing multiple files.

18 parameters
projectIdintegerrequired
The numeric identifier of the project to export.
languagesarray<string>optional
Languages to include in the export. If omitted or null, all languages are exported.
formatstringoptional
Format for the export, such as JSON, XLIFF, PO, PROPERTIES, or YAML.
Allowed:JSONJSON_TOLGEEXLIFFPOAPPLE_STRINGS_STRINGSDICTAPPLE_XLIFFANDROID_XMLCOMPOSE_XMLFLUTTER_ARBPROPERTIESYAML_RUBYYAML
structureDelimiterstringoptional
Delimiter used to structure keys in generic structured formats such as JSON and YAML. Omit it to leave the output unstructured; format-specific formats may ignore it.
filterKeyIdarray<integer>optional
Include only keys with the specified numeric identifiers.
filterKeyIdNotarray<integer>optional
Exclude keys with the specified numeric identifiers.
filterTagstringoptional
Include keys with this single tag.
filterTagInarray<string>optional
Include keys tagged with any of these values.
filterTagNotInarray<string>optional
Exclude keys tagged with any of these values.
filterKeyPrefixstringoptional
Include keys with this prefix.
filterStatearray<string>optional
Filter translations by state: `UNTRANSLATED`, `TRANSLATED`, `REVIEWED`, or `DISABLED`. By default, all states except untranslated are exported.
filterNamespacearray<string>optional
Filter translations by namespace. By default, all namespaces are included; use an empty string to select the default namespace.
zipbooleanoptional
Set to false to return a single file instead of a ZIP archive. This is supported only when exporting one language.
messageFormatstringoptional
Message syntax for generic formats: `C_SPRINTF`, `PHP_SPRINTF`, `JAVA_STRING_FORMAT`, `APPLE_SPRINTF`, `RUBY_SPRINTF`, `I18NEXT`, `ICU`, `PYTHON_PERCENT`, or `PYTHON_BRACE`. Format-specific exports may ignore this parameter.
Allowed:C_SPRINTFPHP_SPRINTFJAVA_STRING_FORMATAPPLE_SPRINTFRUBY_SPRINTFI18NEXTICUPYTHON_PERCENTPYTHON_BRACE
fileStructureTemplatestringoptional
Template for the paths of files in a ZIP archive. Supports `{namespace}`, `{languageTag}`, `{androidLanguageTag}`, `{snakeLanguageTag}`, and `{extension}` placeholders.
supportArraysbooleanoptional
Whether to represent indexed keys as arrays in structured formats.
escapeHtmlbooleanoptional
Whether to escape HTML tags in the exported file. Supported only for XLIFF.
filterBranchstringoptional
Branch whose translations to export. Defaults to the default branch when omitted.

5 status codes
200Returns the exported file directly when one file is produced, or a ZIP archive when multiple files are produced.
400Returned when the export request is invalid, including when `zip` is false and more than one language is selected.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user is not permitted to export the project.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when the export request is invalid, a 401 when authentication is missing or invalid, a 403 when access is forbidden, and a 404 when the project is not found. Setting zip to false requires exporting a single language. The projectId path parameter must identify an existing project.