Endpoints

`GET /v1/{workspaceUrl}/projects/{projectUrl}/resources` -- List resource files

Returns the list of resource files belonging to the specified project. Each entry includes the file name, its associated locale, and a HATEOAS link for downloading the file.

Query Parameters

Parameter	Type	Required	Description
`localeInFileName`	string	No	Controls locale rendering in file names: `ALL` (default), `TARGETS`, or `NONE`
`addIso2Slug`	boolean	No	When `true`, the `iso2_slug` parameter is always appended to rendered resource file URLs

Detail	Value
Auth	`resourcesView` permission on the project
Response	`200` — `V1ResourceInfoList` with `members[]` array

`GET /v1/{workspaceUrl}/projects/{projectUrl}/resources/{fileName}` -- Download a resource file

Downloads the specified resource file as a raw byte stream with appropriate content-type headers. Supports extensive export customization through query parameters.

Path Parameters

Parameter	Type	Description
`fileName`	string	Name of the resource file (e.g. `en.json`)

Query Parameters — Export Customization

All parameters are optional and override the project's default export settings.

Parameter	Type	Description
`path`	string	File path, if `fileName` alone is not unique
`iso2_slug` / `iso2_code`	string	Override the locale code (aliases of each other)
`source:blankContentHandling`	string	Blank source segment handling: `"keep"` or `"skip"`
`target:blankContentHandling`	string	Blank target segment handling: `"fallback"`, `"use_source"`, `"keep"`, or `"skip"`
`source:filterByStatus`	string	Source status filter: `"ALL"`, `"TRANSLATED_AND_APPROVED"`, or `"APPROVED"`
`target:filterByStatus`	string	Target status filter: `"ALL"`, `"TRANSLATED_AND_APPROVED"`, or `"APPROVED"`
`htmlEncoding` / `escapeMode`	string	HTML escape strategy: `"RAW"`, `"ESCAPE"`, or `"CDATA"` (aliases of each other)
`encoding`	string	Character set encoding for the exported file (e.g. `"UTF-8"`, `"ISO-8859-1"`)
`addLocaleInformationToFilename`	string	Locale in file name: `"ALL"`, `"TARGETS"`, or `"NONE"`
`escapeCharacters`	boolean	Whether special characters should be escaped (format-dependent)
`exportTargetComments`	boolean	Include comments in target language exports
`exportSourceLocale`	boolean	For multi-language files: include the source language in the export
`exportHeader`	boolean	Export the file header (if applicable)
`exportTitle`	boolean	Export segment titles (if applicable)
`exportDescription`	boolean	Export segment descriptions
`projectType`	string	Override export format — e.g. download an iOS `.strings` file as Android XML. Allowed: `"ios.strings"`, `"ios.stringsdict"`, `"android.string.resources"`, `"properties"`

Detail	Value
Auth	`resourcesView` permission on the project
Response	`200` — raw file bytes with content-type and charset headers

`POST /v1/{workspaceUrl}/projects/{projectUrl}/resources` -- Upload a resource file

Uploads a single resource file (multipart/form-data). Language is detected automatically from the file name, or can be set explicitly.

Form Parameters

Parameter	Type	Required	Description
`file`	file	Yes	The resource file to upload
`path`	string	No	Target path for the resource container
`iso2_slug` / `iso2_code`	string	No	Override locale detection (aliases of each other)
`source:createNew`	boolean	No	Source language: create new segments
`source:updateExisting`	boolean	No	Source language: update changed segments
`source:deactivateMissing`	boolean	No	Source language: deactivate missing segments
`target:createNew`	boolean	No	Target language: create new segments
`target:updateExisting`	boolean	No	Target language: update changed segments
`target:deactivateMissing`	boolean	No	Target language: deactivate missing segments
`force`	boolean	No	Force upload even if a file name collision is detected (default: `false`)

Detail	Value
Auth	`resourcesManage` permission on the project
Response	`201` — `{"status": "Success"}`

Note: If a collision is detected and force is not true, the endpoint returns 406 Not Acceptable with a descriptive message.

`POST /v1/{workspaceUrl}/projects/{projectUrl}/resources/zip` -- Upload a ZIP archive

Uploads a ZIP archive containing multiple resource files. The archive is extracted and all visible files are imported. Language detection is performed automatically from file names and paths.

Form Parameters

Parameter	Type	Required	Description
`file`	file	Yes	The ZIP archive to upload
`source:createNew`	boolean	No	Source language: create new segments
`source:updateExisting`	boolean	No	Source language: update changed segments
`source:deactivateMissing`	boolean	No	Source language: deactivate missing segments
`target:createNew`	boolean	No	Target language: create new segments
`target:updateExisting`	boolean	No	Target language: update changed segments
`target:deactivateMissing`	boolean	No	Target language: deactivate missing segments

Detail	Value
Auth	`resourcesManage` permission on the project
Response	`201` — `{"status": "Success"}`

`DELETE /v1/{workspaceUrl}/projects/{projectUrl}/resources/{fileName}` -- Delete a resource container

Permanently deletes the specified resource container and all its associated locale files.

Important: The fileName (and optional path) must identify the source language file of the resource container. If the file belongs to a target language, the request is rejected with 400.

Path / Query Parameters

Parameter	Type	Required	Description
`fileName`	string	Yes	File name of the source language resource file
`path`	string	No	File path of the source language resource file

Detail	Value
Auth	`resourcesManage` permission on the project
Response	`200` — empty body

Common Error Responses

Status	Meaning
`400`	Bad Request — invalid parameters or file does not belong to source language
`401`	Unauthorized — authentication credentials are missing or invalid
`403`	Forbidden — insufficient permissions for the requested operation
`404`	Not Found — workspace, project, or resource file does not exist
`406`	Not Acceptable — file name collision detected (upload only, use `force=true`)
`500`	Internal Server Error — unexpected failure during import or export