Translation Config Tool - Api Documentation

Introduction

This is the api documentation for the translation config tool. There is a API endpoint for projects. And an API ADMIN endpoint for the uppartner integration.

The api Endpoint needs an api key. You can get this apikey by looking in the up-partner translation tool. There are two GUIs. See Translation and Config.

Server API Devs: Carolin Etzold and Stefan Zehe

GUI Devs: Julia Wehr

On the left are all api/admin routes listed, that can be used. Please read the description fully, to know what you are doing.

There is also an wiki entry if you are interested in how the client communicates with the api: http://mediawiki.updev.de/index.php/Programmierer:TranslationConfig


Api Routes

This is a list of all available API routes you can use for your client. Please remember that each request needs the "apikey" in headers.

Get config <= version
api
GET/api/project/{apiKey}/config/{versionNumber}
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Response example
                                {
    "configVersion": "string",
    "configName": "mixed|string"
}
                            
Get config <= version structured
api
GET/api/project/{apiKey}/config/{versionNumber}/structured
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Response example
                                {
    "configs": [
        {
            "Name": "string",
            "Content": "string"
        }
    ],
    "configVersion": "string"
}
                            
Get only config by name <= version
api
GET/api/project/{apiKey}/config/{name}/{versionNumber}
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Response example
                                mixed
                            
Clear server cache and invalidate cdn for config
api
POST/api/project/config/cache/invalidate
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
version string YES The version number, e.g. 0.1, * 1.20.12, ... Postfields
Response example
                                {
    "success": "bool"
}
                            
Get meta information like last_config_modified and * lst_config_modified_hash for version
api
GET/api/project/get/{apiKey}/config/{versionNumber}/meta
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Response example
                                {
    "id": "int",
    "version": "string",
    "active": "int",
    "last_translation_modification": "type unclear",
    "last_config_modification": "type unclear",
    "last_config_modified_hash": "type unclear",
    "major_version": "int",
    "minor_version": "int",
    "patch_version": "int",
    "language_modifications": "type unclear",
    "mark_as_deleted": "type unclear"
}
                            
Import json config
api
POST/api/project/config/import/json
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
configName string YES The table/config name of the config Postfields
data string YES The json config data as text Postfields
versionNumber string YES The version number, e.g. 0.1, 1.20.12, ... Postfields
Response example
                                {
    "id": "int",
    "payload": "mixed",
    "histories": [],
    "createdTranslationKeys": [
        "string"
    ],
    "updatedTranslationKeys": [
        "string"
    ]
}
                            
Import keys with translation
api
POST/api/project/translation/import
If you have an existing game you can import keys with * translation here. You can set a branchId in json, and key will be * imported for the branch if it exist, otherwise master branch. Master * branch is default. ATTENTION: Import list can not be longer than 100 * items!INPUT FORMAT for 'importList' parameter (array): *
[{'keyName': 'baroo', 'languageId': 1, 'translation': * 'bazoo', 'branchId':123},{'keyName': 'foo', 'languageId': 1, 'translation': * 'bar'},{'keyName': 'bar', 'languageId': 1, 'translation': * 'baz'},{'keyName': 'bar_no_translate', 'languageId': 1, 'translation': * 'notranslation needed', 'doNotTranslate':true},{'keyName': * 'xyz'}]
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
importList json YES Json Data to be imported. Postfields
Response example
                                {
    "success": "bool"
}
                            
Import keys
api
POST/api/project/translation/importkeys
If you have an existing game you can import keys * here. You can set a branchId in json, and key will be * imported for the branch if it exist, otherwise master branch. Master * branch is default. ATTENTION: Import list can not be longer than 100 items!INPUT * FORMAT for importList parameter (array):
[{'keyName': 'baroo', 'languageId': 1, 'translation': * 'bazoo', 'branchId':123},{'keyName': 'foo', 'languageId': 1, 'translation': * 'bar'},{'keyName': 'bar', 'languageId': 1, 'translation': * 'baz'},{'keyName': 'bar_no_translate', 'languageId': 1, * 'translation': 'notranslation needed', * 'doNotTranslate':true},{'keyName': 'xyz'}]
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
importList json YES Json Data to be imported. Postfields
Response example
                                {
    "success": "bool"
}
                            
Create key for branch
api
POST/api/branch/{branchId}/key
Create a new key for branch
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
branchId int The id of * branch
Parameters for Request
Name data type required description format in
name string YES The key name Postfields
content string NO The content/translation for key Postfields
languageId int NO The language id Postfields
comment string NO A comment for the key Postfields
doNotTranslate bool NO Flag to mark key for no translation needed Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "imported": "bool"
}
                            
Rename key
api
POST/api/project/key/rename
Rename a key. New Key is send back in response. * ATTENTION: A key rename can not happen in the system, because keys * are for all projects. So the only thing that happens is, that the * new key is created with existing translations from key to rename. * After creation, the key to rename is deleted from project/branches. * This can take several hours till each CDN content is invalidated and * the new key is present on CDN!
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
keyToRename string NO The name of the key that for rename Postfields
newName string NO The new key name Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "imported": "bool"
}
                            
Delete a translation key from master branch
api
POST/api/key
ATTENTION: Only use if you know what you are doing! Please check that you know what your doing before you use this! * This feature removes a key by name from the projects master branch. * This concerns that the key is lost for all project versions! * So if your app needs the key, then do not delete it!!!
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
key string YES The key name Postfields
Response example
                                {
    "success": "bool"
}
                            
Get translations by branch for all project languages
api
POST/api/branch/{branchId}/translations
Get translation content by given branch id and get also * meta info and used branches info in response
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
id int YES The id of the branch Postfields
Response example
                                {
    "content": {
        "de": {
            "key1": "key1 Translation",
            "key2": "key2 Translation"
        },
        "en": {
            "key1": "key1 Translation",
            "key2": "key2 Translation"
        }
    },
    "used_branches": [
        {
            "id": "int",
            "name": "string",
            "start_version": "string",
            "end_version": "string",
            "released": "bool",
            "from": "null|string",
            "to": "null|string"
        }
    ],
    "meta": {
        "last_modified": {
            "0.1.1": {
                "date": "2020-05-08 17:11:59.927663",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            }
        }
    }
}
                            
Get project information
api
GET/api/project/{apiKey}
Get project information data
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey string The apikey of project
Response example
                                {
    "id": "int",
    "name": "string",
    "apiKey": "string",
    "created_at": {
        "date": "2026-11-21 01:23:41.804860",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "active": "bool"
}
                            
Get project meta data
api
GET/api/project/get/{apiKey}/{version}/{languageCode}/meta
Gets `last_modified` for specified version and * language.Use `last_modified` from result to determine if your local * translation-cache needs an invalidation.
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey int The apikey * of project
version string The * version number
languageCode string The * language code like de,en,...
Response example
                                {
    "last_modified": {
        "unixtimestamp": "int",
        "unixtimestamp_milliseconds": "int"
    },
    "last_config_modified": {
        "unixtimestamp": "int",
        "unixtimestamp_milliseconds": "int"
    }
}
                            
Get keys for version, languageCode - Content is cached!
api
GET/api/project/get/{apiKey}/{version}/{languageCode}
Gets all keys and translations for specified version * and language.
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey int The apikey * of project
version string The * version number
languageCode string The * language code like de,en,...
Response example
                                {'content':{'keyName1':'foobar','keyName2':'404_keyName2'},'used_branches':'BranchBundle\Entity\Branch','meta':{'last_modified':'date'}}
                            
Get content in other format (json/xml/csv)
api
GET/api/project/export/{apiKey}/{version}/{languageCode}/{serializer}
Get translation data in different formats
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey int The apikey * of project
version string The * version number
languageCode string The * language code like de,en,...
serializer string The * serializer format (Json|Xml|Csv)
Clear the cache for api routes
api
POST/api/project/cache/invalidate/apiroute
Clear the cache for api routes
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
projectId integer YES The project id Postfields
version string YES The version number Postfields
languageCode string YES The language code Postfields
Response example
                                {
    "success": "true"
}
                            
Get all languages of project
api
GET/api/project/{apikey}/languages
Get a list of enabled languages for the project
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apikey string The * apikey of project
Response example
                                [
    {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
]
                            
Get keys for version for all languages - Content is cached!
api
GET/api/project/all/{apiKey}/{version}
Gets all keys and translations for all languages by * specified version.
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey string The * apikey of project
version string The * version number
Response example
                                {'content':{'keyName1':'foobar','keyName2':'404_keyName2'},'used_branches':'BranchBundle\Entity\Branch','meta':{'last_modified':'date'}}
                            
Get all project versions
api
GET/api/project/{apiKey}/versions
Get all project versions. Deleted versions are not * delivered.
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey string The * apikey of project
Response example
                                [
    {
        "id": "int",
        "version": "string",
        "active": "int",
        "last_translation_modification": "type unclear",
        "last_config_modification": "type unclear",
        "last_config_modified_hash": "type unclear",
        "major_version": "int",
        "minor_version": "int",
        "patch_version": "int",
        "language_modifications": "type unclear",
        "mark_as_deleted": "type unclear"
    }
]
                            
Get all versions by major version number
api
GET/api/project/{apiKey}/versions/{versionNumber}
Get all project versions by major version number.
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey string The * apikey of project
versionNumber string The version number
Response example
                                [
    {
        "id": null,
        "version": null,
        "active": null,
        "last_translation_modification": null,
        "last_config_modification": null,
        "last_config_modified_hash": null,
        "major_version": null,
        "minor_version": null,
        "patch_version": null,
        "language_modifications": []
    }
]
                            
Get translation process
api
GET/api/project/{apiKey}/languages/process
Get translation process for all project languages. Origin language is default german (de)
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey string The * apikey of project
Response example
                                [
    {
        "id": "int",
        "code": "string",
        "language_name": "string",
        "translationCountSum": "int",
        "keyCountSum": "int"
    }
]
                            
Get branches of project.
api
GET/api/project/{apiKey}/branches
Get all branches of the project
Request Headers
name data type required description
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
apiKey string The * apikey of project
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "start_version": "string",
        "end_version": "string",
        "released": "bool",
        "from": {
            "date": "2026-11-21 01:23:41.813980",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "to": {
            "date": "2026-11-21 01:23:41.814252",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        }
    }
]
                            

Admin Routes


Create config table - excel sheet
admin
POST/admin/project/{id}/config/table
Create an config sheet. In excel format, this means a * new table sheet inside the excel document.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project id
Parameters for Request
Name data type required description format in
name string YES The sheet name Postfields
version string YES The project version Postfields
Response example
                                {
    "id": "int",
    "inactive": "bool"
}
                            
Get all config tables (sheets)
admin
GET/admin/project/{id}/config/tables
Get a list of all config tables (sheets) of the excel * document
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project id
Response example
                                [
    {
        "id": "int",
        "inactive": "bool"
    }
]
                            
Get config tables (sheets) by version
admin
GET/admin/project/{id}/config/tables/{version}
Get a list of all config tables (sheets) of the excel * document by a given version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
version string The * version number like 1.0.0
Response example
                                [
    {
        "id": "int",
        "inactive": "bool"
    }
]
                            
Set config table inactive
admin
PUT/admin/project/{id}/config/table/{configId}/version/{versionNumber}/inactive
Set a given config table inactive
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
configId int The id of * config table sheet
versionNumber string The version number like 1.0.0
Parameters for Request
Name data type required description format in
inactive boolean NO Set config inactive Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "type": "string",
    "config": "string|array|object",
    "comment": "string",
    "delimiter": "string",
    "deleted": "bool",
    "versionId": "type unclear",
    "version": "type unclear",
    "canBeEmpty": "bool",
    "canBeUnique": "bool"
}
                            
Get scheme types
admin
GET/admin/project/config/scheme/types
Get a list of data types that are allowed for your * excel document
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Response example
                                [
    {
        "datatype": "string",
        "description": "string"
    }
]
                            
Create config scheme for config tables (sheets)
admin
POST/admin/project/{id}/config/table/{configId}/scheme
Create a scheme for a sheet. This means define columns * for the sheet.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
configId int The id of * config sheet (table)
Parameters for Request
Name data type required description format in
name string YES The name of the scheme Postfields
type string YES The scheme type Postfields
config string NO The config for the scheme item. Notation (json * array): ['bar', 'baz'] Postfields
comment string NO A comment for the scheme item Postfields
versionId int YES The related version id from config sheet. Postfields
delimiter string NO A delimiter for array type. E.g.: | , / \ : :: - * _ + ~ # Postfields
canBeEmpty int YES 1 = activate, 0 = deactivate Postfields
canBeUnique int YES 1 = activate, 0 = deactivate Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "type": "string",
    "config": "string|array|object",
    "comment": "string",
    "delimiter": "string",
    "deleted": "bool",
    "versionId": "type unclear",
    "version": "type unclear",
    "canBeEmpty": "bool",
    "canBeUnique": "bool"
}
                            
Update config scheme item
admin
PUT/admin/project/{id}/config/table/{configId}/scheme/{schemeId}
Update a single config scheme item (coloumn * definition)
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
config int The id of * config table sheet
schemeId int The id of * config scheme (column definition)
Parameters for Request
Name data type required description format in
name string YES The scheme name Postfields
type string YES The scheme type Postfields
config string NO The config for the scheme item. Notation (json * array): ['bar', 'baz'] Postfields
comment string NO A comment for the scheme item Postfields
versionId int YES A version id Postfields
delimiter string NO A delimiter for array type. E.g.: | , / \ : :: - * _ + ~ # Postfields
canBeEmpty int YES 1 = activate, 0 = deactivate Postfields
canBeUnique int YES 1 = activate, 0 = deactivate Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "type": "string",
    "config": "string|array|object",
    "comment": "string",
    "delimiter": "string",
    "deleted": "bool",
    "versionId": "type unclear",
    "version": "type unclear",
    "canBeEmpty": "bool",
    "canBeUnique": "bool"
}
                            
Delete config scheme item
admin
DELETE/admin/project/{id}/config/scheme/{schemeId}
Delete a config scheme item (column definition)
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
schemeId int The id of * config scheme (column definition)
Response example
                                bool
                            
Get config scheme items for specific version
admin
GET/admin/project/{id}/config/table/{configId}/{versionId}/scheme
Get defined scheme items (column definitions) for * specific version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
configId int The id of * config table sheet
versionId int The id of * version
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "type": "string",
        "config": "string|array|object",
        "comment": "string",
        "delimiter": "string",
        "deleted": "bool",
        "versionId": "type unclear",
        "version": "type unclear",
        "canBeEmpty": "bool",
        "canBeUnique": "bool"
    }
]
                            
Get config scheme items merged by version number
admin
GET/admin/project/{id}/config/table/{configId}/scheme/{versionNumber}
Get defined scheme items (column definitions) merged * with lower versions starting from given version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
configId int The id of * config table sheet
versionNumber string The version number like 1.0.0
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "type": "string",
        "config": "string",
        "delimiter": "string",
        "version": "string",
        "comment": "string",
        "canBeEmpty": "bool",
        "canBeUnique": "bool"
    }
]
                            
Get config data for specific config and version
admin
GET/admin/project/{id}/config/table/{configId}/{versionId}/data
Get config date for given sheet and version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
configId int The id of * config table sheet
versionId int The id of * version
Response example
                                {
    "id": "int",
    "inactive": "bool"
}
                            
Get all config data by version
admin
GET/admin/project/{id}/config/{versionId}/data
Get all defined sheet config datas for version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
versionId int The id of * version
Response example
                                {
    "name": "string",
    "id": "int",
    "configData": "string",
    "version": "string",
    "major_version": "string",
    "minor_version": "string",
    "patch_version": "string"
}
                            
Update config data
admin
PUT/admin/project/{id}/config/data/{dataId}
Replace existing config data with the complete payload. Columns without a schema are preserved as supplied; defined columns retain schema validation.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
dataId int The id of * data entry
Parameters for Request
Name data type required description format in
payload string YES Config Data (Json encoded data string) Postfields
comment string NO A comment why you import. Default comment is * 'Updated config' Postfields
Response example
                                {
    "id": "int",
    "payload": "array|object|string",
    "histories": {}
}
                            
Delete config table
admin
DELETE/admin/project/{id}/config/{configId}
Delete config sheet (table)
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project * id
configId int The id of * config table sheet
Response example
                                bool
                            
Clear server cache and invalidate cdn
admin
POST/admin/project/config/cache/invalidate
Clear the servers cache and invalidate routes on cdn. ATTENTION: The CDN Invalidation can take a lot of time till finished.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
projectId integer YES The project id Postfields
version string YES The version number, e.g. 0.1, * 1.20.12, ... Postfields
Response example
                                {
    "success": "bool"
}
                            
Upload config file
admin
POST/admin/project/{projectId}/config/{versionId}/file/upload
Upload a new config excel file
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The project id
versionId int The id of version
Parameters for Request
Name data type required description format in
file file YES Config file to upload Postfields
Response example
                                {
    "id": "int",
    "configFile": "string",
    "original_file_name": "type unclear",
    "created": {
        "date": "2026-11-21 01:23:41.836873",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "config_file_last_import": "string"
}
                            
Get config files
admin
GET/admin/project/{projectId}/config/{versionId}/files
Get all config files for version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The project id
versionId int The version id
Response example
                                [
    {
        "id": "int",
        "configFile": "string",
        "original_file_name": "type unclear",
        "created": {
            "date": "2026-11-21 01:23:41.838351",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "config_file_last_import": "string"
    }
]
                            
Delete uploaded config excel file
admin
DELETE/admin/project/{id}/config/file/{fileId}
Delete an existing config excel file
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The project id
fileId int The id of config file
Response example
                                bool
                            
Import a config file
admin
POST/admin/project/{projectId}/config/{configId}/import/file/{configFileId}
Import a new config file
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The * project id
configId int The id of * config table sheet
configFileId int The id * of config file
Parameters for Request
Name data type required description format in
comment string NO A comment why you import. Default comment is * 'Freshly Import' Postfields
Response example
                                {
    "config_file_id": "int",
    "config_file_last_import": "string",
    "createdTranslationKeys": [
        "string"
    ],
    "updatedTranslationKeys": [
        "string"
    ]
}
                            
Import a json config
admin
POST/admin/project/{projectId}/config/{configId}/import/json
Import config data provided directly as a json text
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The * project id
configId int The id of * config table sheet
Parameters for Request
Name data type required description format in
json string YES The config data as json text Postfields
version string NO The version number, e.g. 0.1, 1.20.12, ... * If it does not exist yet, it is created as inactive. Postfields
comment string NO A comment why you import. Default comment is * 'Freshly Import' Postfields
Response example
                                {
    "id": "int",
    "payload": "mixed",
    "histories": [],
    "createdTranslationKeys": [
        "string"
    ],
    "updatedTranslationKeys": [
        "string"
    ]
}
                            
Import a tsv config
admin
POST/admin/project/{projectId}/config/{configId}/import/tsv
Import config data provided directly as tab separated (tsv) text
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The * project id
configId int The id of * config table sheet
Parameters for Request
Name data type required description format in
tsv string YES The config data as tab separated (tsv) text, first line is * used as header Postfields
version string NO The version number, e.g. 0.1, 1.20.12, ... * If it does not exist yet, it is created as inactive. Postfields
comment string NO A comment why you import. Default comment is * 'Freshly Import' Postfields
Response example
                                {
    "relation": {
        "id": "int",
        "inactive": "bool"
    },
    "silentColumns": {
        "cellName": "bool"
    },
    "createdTranslationKeys": [
        "string"
    ],
    "updatedTranslationKeys": [
        "string"
    ]
}
                            
Preview an excel config import
admin
POST/admin/project/{projectId}/config/{configId}/import/file/{configFileId}/preview
Parses and validates an already uploaded config file, without persisting * anything. Returns the new (not yet saved) payload next to the currently persisted * payload for comparison.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The * project id
configId int The id of * config table sheet
configFileId int The id * of config file
Response example
                                {
    "newPayload": {},
    "currentPayload": {},
    "silentColumns": {
        "cellName": "bool"
    },
    "newTranslationKeys": [
        "string"
    ]
}
                            
Preview a json config import
admin
POST/admin/project/{projectId}/config/{configId}/import/json/preview
Decodes the given json config data, without persisting anything. Returns * the new (not yet saved) payload next to the currently persisted payload for * comparison.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The * project id
configId int The id of * config table sheet
Parameters for Request
Name data type required description format in
json string YES The config data as json text Postfields
version string NO The version number, e.g. 0.1, 1.20.12, ... Postfields
Response example
                                {
    "newPayload": {},
    "currentPayload": {},
    "silentColumns": {
        "cellName": "bool"
    },
    "newTranslationKeys": [
        "string"
    ]
}
                            
Preview a tsv config import
admin
POST/admin/project/{projectId}/config/{configId}/import/tsv/preview
Parses and validates the given tab separated (tsv) text, without * persisting anything. Returns the new (not yet saved) payload next to the currently * persisted payload for comparison.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The * project id
configId int The id of * config table sheet
Parameters for Request
Name data type required description format in
tsv string YES The config data as tab separated (tsv) text, first line is * used as header Postfields
version string NO The version number, e.g. 0.1, 1.20.12, ... Postfields
Response example
                                {
    "newPayload": {},
    "currentPayload": {},
    "silentColumns": {
        "cellName": "bool"
    },
    "newTranslationKeys": [
        "string"
    ]
}
                            
Import keys (with translation)
admin
POST/admin/project/{projectId}/translation/import
If you have an existing game you can import keys with * translation here. You can set a branchId in json, and key will be * imported for the branch if it exist, otherwise master branch. Master * branch is default. ATTENTION: Import list can not be longer than 100 * items!INPUT FORMAT for importList parameter (array): *
[{'keyName': 'baroo', 'languageId': 1, 'translation': * 'bazoo', 'branchId':123},{'keyName': 'foo', 'languageId': 1, * 'translation': 'bar'},{'keyName': 'bar', 'languageId': 1, 'translation': * 'baz'},{'keyName': 'bar_no_translate', 'languageId': 1, 'translation': * 'notranslation needed', 'doNotTranslate':true},{'keyName': * 'xyz'}]
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of * project
Parameters for Request
Name data type required description format in
importList json YES Json Data to be imported. Postfields
Response example
                                {
    "success": "bool"
}
                            
Get user
admin
GET/admin/user/{userId}
Get a user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
userId int The id of user
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.843877",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.846292",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
Get users
admin
GET/admin/user
Get all users
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
Response example
                                [
    {
        "id": "int",
        "created_at": {
            "date": "2026-11-21 01:23:41.849433",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "projects": [
            {
                "id": "int",
                "name": "string",
                "apiKey": "string",
                "created_at": {
                    "date": "2026-11-21 01:23:41.851754",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "active": "bool"
            }
        ],
        "originLanguage": {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    }
]
                            
Delete user
admin
DELETE/admin/user
Delete an existing user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
id integer YES The id of the user Postfields
Response example
                                {
    "success": "bool"
}
                            
Create user
admin
POST/admin/user
Create a new user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
id integer YES The id of the user Postfields
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.855383",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.857731",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
Set origin language for user
admin
POST/admin/user/{userId}/origin-language
Set the origin language for user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
userId int The id of user
Parameters for Request
Name data type required description format in
id integer YES The id of the language Postfields
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.860998",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.863370",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
Get origin language from user
admin
GET/admin/user/{userId}/origin-language
Get users origin language
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
userId int The id of user
Response example
                                {
    "id": "int",
    "code": "string",
    "language_name": "string"
}
                            
Remove language from user
admin
DELETE/admin/user/{userId}/language
Remove an enabled language from user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
userId int The id of user
Parameters for Request
Name data type required description format in
id integer YES The id of the language Postfields
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.868174",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.870539",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
Get user languages
admin
GET/admin/user/{userId}/languages
Get a list of enabled languages of user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
userId int The id of user
Response example
                                [
    {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
]
                            
Update user
admin
PUT/admin/user/{userId}/language
Update an existing user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
userId int The id of user
Parameters for Request
Name data type required description format in
id integer YES The id of the language Postfields
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.874923",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.877234",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
Get projects of user
admin
GET/admin/user/{userId}/projects
Get a list projects for user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
userId int The id of user
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "apiKey": "string",
        "created_at": {
            "date": "2026-11-21 01:23:41.881172",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "active": "bool"
    }
]
                            
Add project to user
admin
PUT/admin/user/{userId}/project
Add a project for user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
userId int The id of user
Parameters for Request
Name data type required description format in
id integer YES The id of the project Postfields
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.883484",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.885825",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
Remove project from user
admin
DELETE/admin/user/{userId}/project
Remove a project from user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
userId int The id of user
Parameters for Request
Name data type required description format in
id integer YES The id of the project Postfields
Response example
                                {
    "id": "int",
    "created_at": {
        "date": "2026-11-21 01:23:41.889073",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "projects": [
        {
            "id": "int",
            "name": "string",
            "apiKey": "string",
            "created_at": {
                "date": "2026-11-21 01:23:41.891408",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "languages": [
                {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            ],
            "active": "bool"
        }
    ],
    "originLanguage": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
}
                            
List branch keys
admin
GET/admin/branch/{branchId}/keys
List all keys in branch
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
branchId int The id of * branch
Response example
                                [
    {
        "id": "int",
        "branch": {
            "id": "int",
            "name": "string",
            "start_version": "string",
            "end_version": "string",
            "released": "bool",
            "from": {
                "date": "2026-11-21 01:23:41.896226",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "to": {
                "date": "2026-11-21 01:23:41.896483",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            }
        },
        "key": {
            "id": "int",
            "name": "string",
            "imported": "bool"
        },
        "translation": {
            "id": "int",
            "content": "string",
            "created": {
                "date": "2026-11-21 01:23:41.898566",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "language": {
                "id": "int",
                "code": "string",
                "language_name": "string"
            },
            "user": {
                "id": "int",
                "created_at": {
                    "date": "2026-11-21 01:23:41.900309",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "projects": [
                    {
                        "id": "int",
                        "name": "string",
                        "apiKey": "string",
                        "created_at": {
                            "date": "2026-11-21 01:23:41.902847",
                            "timezone_type": 3,
                            "timezone": "Europe\/Berlin"
                        },
                        "languages": [
                            {
                                "id": "int",
                                "code": "string",
                                "language_name": "string"
                            }
                        ],
                        "active": "bool"
                    }
                ],
                "originLanguage": {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            },
            "to_verify": "mixed",
            "comment": "string",
            "deeplUsed": "bool",
            "deeplEdited": "bool"
        },
        "deleted_from_branch": "type unclear"
    }
]
                            
Count keys by branch
admin
GET/admin/branch/{branchId}/keys/count
Get a number of keys in branch
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
branchId int The id of * branch
Response example
                                int
                            
Create key for branch
admin
POST/admin/branch/{branchId}/key
Create a new key for branch
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
branchId int The id of * branch
Parameters for Request
Name data type required description format in
name string NO The key name Postfields
content string NO The content/translation for key Postfields
languageId int NO The language id Postfields
comment string NO The language id Postfields
doNotTranslate bool NO Flag to mark key for no translation needed Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "imported": "bool"
}
                            
Rename key
admin
POST/admin/project/{projectId}/key/{keyId}/rename
Rename a key. ATTENTION: A key rename can not happen in * the system, because keys are for all projects. So the only thing * that happens is, that the new key is created with existing * translations from key to rename. After creation, the key to rename * is deleted from project/branches. This can take several hours till * each CDN content is invalidated and the new key is present on CDN!
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of * project
keyId int The id of the * key to rename
Parameters for Request
Name data type required description format in
name string NO The new key name Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "imported": "bool"
}
                            
Move key
admin
PUT/admin/branch/{sourceBranchId}/key/{keyId}/move
Move key to an other branch
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
sourceBranchId int The * id source branch
keyId int The id of * key
Parameters for Request
Name data type required description format in
targetBranchId integer YES The id of the target branch Postfields
Response example
                                {
    "success": "bool"
}
                            
Delete key from branch
admin
DELETE/admin/key
Delete a key from branch. If you delete key in master * it is gone. You can reactivate the key if you create a new one
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
branch integer YES The id of the branch Postfields
key integer YES The id of the key Postfields
Response example
                                {
    "success": "bool"
}
                            
Get a list of languages
admin
GET/admin/language
Get a list of languages that are available in server
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
Response example
                                [
    {
        "id": "int",
        "code": "string",
        "language_name": "string"
    }
]
                            
Get a language
admin
GET/admin/language/{languageId}
Get language data for language id
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
languageId int The id of language code
Response example
                                {
    "id": "int",
    "code": "string",
    "language_name": "string"
}
                            
Create a language
admin
POST/admin/language
Create a new language if needed
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
languageName string NO The language name Postfields
code string NO The language code (de/en/...) for translation Postfields
Response example
                                {
    "id": "int",
    "code": "string",
    "language_name": "string"
}
                            
Delete a language
admin
DELETE/admin/language/{languageId}
Delete a given language
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
languageId int The id of language code
Get projects of user by language code
admin
GET/admin/language/{languageId}/projects
Get a list of projects for user with given language code.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
languageId int The id of language code
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "apiKey": "string",
        "created_at": {
            "date": "2026-11-21 01:23:41.915337",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "active": "bool"
    }
]
                            
Get user by language
admin
GET/admin/language/{languageId}/users
Get a list of users by language
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
languageId int The id of language code
Response example
                                [
    {
        "id": "int",
        "created_at": {
            "date": "2026-11-21 01:23:41.917547",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "projects": [
            {
                "id": "int",
                "name": "string",
                "apiKey": "string",
                "created_at": {
                    "date": "2026-11-21 01:23:41.919854",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "active": "bool"
            }
        ],
        "originLanguage": {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    }
]
                            
Copy translations
admin
POST/admin/translation/copy
Copy selected keys using POST parameters into another project or branch. Missing branches use master, * missing versions use 0.1.0. update accepts a Boolean or 0/1; existing target texts require update=1.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Copy committed; warnings report any subsequent invalidation failure
400 Invalid input, access denied or copy conflict
Parameters for Request
Name data type required description format in
sourceProjectId int YES Source project ID Postfields
targetProjectId int YES Target project ID Postfields
keys array YES Non-empty list of key names Postfields
sourceBranch string NO Source branch; default master Postfields
targetBranch string NO Target branch; default master Postfields
sourceVersion string NO Source version; default 0.1.0 Postfields
targetVersion string NO Target version; default 0.1.0 Postfields
update boolean NO Update existing translations; default false Postfields
Response example
                                {
    "created": "int",
    "updated": "int",
    "infos": [
        {
            "languageCode": "string",
            "keys": "string[]",
            "reason": "string"
        }
    ],
    "warnings": [
        {
            "reason": "string",
            "message": "string"
        }
    ]
}
                            
Update translation
admin
PUT/admin/translation/{id}
Update an existing translation
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The id of translation entry
Parameters for Request
Name data type required description format in
content string YES translation content Postfields
toVerify boolean YES need translation verification? Postfields
comment string NO comment content Postfields
doNotTranslate bool NO Flag to mark key for no translation needed Postfields
deeplUsed bool NO Flag to mark deepl was used for this translation Postfields
deeplEdited bool NO Flag to mark deepl was used for this translation and the text was edited Postfields
Response example
                                {
    "id": "int",
    "content": "string",
    "created": {
        "date": "2026-11-21 01:23:41.924438",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "language": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    },
    "user": {
        "id": "int",
        "created_at": {
            "date": "2026-11-21 01:23:41.926222",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "projects": [
            {
                "id": "int",
                "name": "string",
                "apiKey": "string",
                "created_at": {
                    "date": "2026-11-21 01:23:41.928523",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "active": "bool"
            }
        ],
        "originLanguage": {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    },
    "to_verify": "mixed",
    "comment": "string",
    "deeplUsed": "bool",
    "deeplEdited": "bool"
}
                            
Create translation
admin
POST/admin/translation
Create a new translation for key
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
language integer YES The language id Postfields
branch integer YES The branch id Postfields
key integer YES The key id Postfields
content string YES The translation content Postfields
comment string NO A comment for translation Postfields
toVerify boolean NO need translation verification? Postfields
deeplUsed bool NO Flag to mark deepl was used for this translation Postfields
deeplEdited bool NO Flag to mark deepl was used for this translation and the text was edited Postfields
Response example
                                {
    "id": "int",
    "content": "string",
    "created": {
        "date": "2026-11-21 01:23:41.933426",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "language": {
        "id": "int",
        "code": "string",
        "language_name": "string"
    },
    "user": {
        "id": "int",
        "created_at": {
            "date": "2026-11-21 01:23:41.935200",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "projects": [
            {
                "id": "int",
                "name": "string",
                "apiKey": "string",
                "created_at": {
                    "date": "2026-11-21 01:23:41.937533",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "active": "bool"
            }
        ],
        "originLanguage": {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    },
    "to_verify": "mixed",
    "comment": "string",
    "deeplUsed": "bool",
    "deeplEdited": "bool"
}
                            
Delete translation
admin
DELETE/admin/translation/{id}
Delete an existing translation
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The id of translation entry
Get translation suggestions
admin
GET/admin/branch/{branchId}/key/{keyId}/translation/suggestions/{languageId}
Get a list of translation suggestions
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
branchId int The id of branch
keyId int The id of key
languageId int The id of language
Response example
                                [
    {
        "id": "int",
        "branch": {
            "id": "int",
            "name": "string",
            "start_version": "string",
            "end_version": "string",
            "released": "bool",
            "from": {
                "date": "2026-11-21 01:23:41.943553",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "to": {
                "date": "2026-11-21 01:23:41.943809",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            }
        },
        "key": {
            "id": "int",
            "name": "string",
            "imported": "bool"
        },
        "translation": {
            "id": "int",
            "content": "string",
            "created": {
                "date": "2026-11-21 01:23:41.945818",
                "timezone_type": 3,
                "timezone": "Europe\/Berlin"
            },
            "language": {
                "id": "int",
                "code": "string",
                "language_name": "string"
            },
            "user": {
                "id": "int",
                "created_at": {
                    "date": "2026-11-21 01:23:41.947541",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "projects": [
                    {
                        "id": "int",
                        "name": "string",
                        "apiKey": "string",
                        "created_at": {
                            "date": "2026-11-21 01:23:41.949941",
                            "timezone_type": 3,
                            "timezone": "Europe\/Berlin"
                        },
                        "languages": [
                            {
                                "id": "int",
                                "code": "string",
                                "language_name": "string"
                            }
                        ],
                        "active": "bool"
                    }
                ],
                "originLanguage": {
                    "id": "int",
                    "code": "string",
                    "language_name": "string"
                }
            },
            "to_verify": "mixed",
            "comment": "string",
            "deeplUsed": "bool",
            "deeplEdited": "bool"
        },
        "deleted_from_branch": "type unclear"
    }
]
                            
Get translations by branch and key
admin
GET/admin/branch/{branchId}/key/{keyId}/translations
Get all translations by branch and key
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
branchId int The id of branch
keyId int The id of key
Get translation progress
admin
GET/admin/branch/{branchId}/translations/{languageId}/progress
Get the translation progress for project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
branchId int The id of branch
languageId int The id of language
Get translation history
admin
GET/admin/translation/history/{translationId}
Get a history of translations for key
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
translationId int The id of translation entry
Search translations
admin
POST/admin/project/{projectId}/translations/{languageId}/search
The query parameter should contain some of these: key, * branch, missing, targetTranslation, originTranslation, toVerify, * limit, offset
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
languageId int The id * of language code
Parameters for Request
Name data type required description format in
query object YES A search query that contains key, branch, * missing, targetTranslation, originTranslation, toVerify, limit, * offset Postfields
Response example
                                [{
    'branchId':'int',
    'branchName':'string',
    'keyId:'int',
    'keyName':'string',
    'doNotTranslate':'bool',
    'translationContent':'string',
    'toVerify':'bool',
    'translationReleased':'bool',
    'originTranslation':'string',
    'originTranslationId':'int',
    'originLanguage':'int',
    'translationId':'int',
    'comment:'string',
    'deleted_from_branch':'bool',
    'targetTranslationUpdateDate':'\DateTime',
    'originTranslationUpdateDate':'\DateTime',
    'originTranslationChanged':'bool';
    }]
                            
Get specific translations for keys
admin
GET/admin/project/{projectId}/translations/specific
Send a specific list of keys and get the corresponding translation in each project language.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of project
Parameters for Request
Name data type required description format in
keys array YES A simple array list of keys Postfields
Response example
                                [
    {
        "languageCode": "string",
        "languageId": "int",
        "languageName": "string",
        "translations": [
            {
                "keyName": "string",
                "content": "string"
            }
        ]
    }
]
                            
Count translations
admin
POST/admin/project/{projectId}/translations/{languageId}/count
Get an amount of translations for project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
languageId int The id * of language code
Response example
                                int
                            
Get amount of origin updates
admin
GET/admin/project/{projectId}/translations/{targetLanguageId}/originupdatecount
Get the amount for updates in the origin language
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of * project
targetLanguageId int The id of target language code
Response example
                                {
    "amount": "int"
}
                            
Translate given string with deepl
admin
POST/admin/deepl/translate
Create a new project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
text string YES The string that needs a translation Postfields
sourceLanguageCode string YES The language code to translate from Postfields
targetLanguageCode string YES The language code to translate to Postfields
Response example
                                {
    "translatedText": "string",
    "detectedSourceLang": "string"
}
                            
Create a Jira Ticket
admin
POST/admin/project/{projectId}/jira/ticket/create
Jira Project Id is required here, mapping is in up-partner.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId string The project id from translation tool
Parameters for Request
Name data type required description format in
title string YES Title for the jira ticket, user input Postfields
description string YES Description text for the jira ticket, user input Postfields
duedate int YES Unixtimestamp for tickets due date Postfields
jiraprojectid int YES The jira project id, mapping in up-partner Postfields
Response example
                                {
    "success": "bool",
    "error": "null|string",
    "jiraResponse": "null|string"
}
                            
Create branch
admin
POST/admin/project/{project}/branch
Create a branch for project. You can set date from/to to define when branch is used, or from/to version. All translations will then be merged with other branches/versions.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The project id
Parameters for Request
Name data type required description format in
name string YES The name of the branch Postfields
from datetime string YES Date yyyy-MM-dd HH:mm:ss Postfields
to datetime string NO Date yyyy-MM-dd HH:mm:ss Postfields
start_version string YES A start version 0.1, 1.0, 1.0.0, * ... Postfields
end_version string NO A start version 0.1, 1.0, 1.0.0, * ... Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "start_version": "string",
    "end_version": "string",
    "released": "bool",
    "from": {
        "date": "2026-11-21 01:23:41.959480",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "to": {
        "date": "2026-11-21 01:23:41.959737",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    }
}
                            
Edit branch
admin
PUT/admin/project/{projectId}/branch/{branchId}
Edit an existing branch and set the needed values.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The project id
branchId int The id of branch
Parameters for Request
Name data type required description format in
name string YES The name of the branch Postfields
from datetime string YES Date, format: yyyy-MM-dd HH:mm:ss Postfields
to datetime string NO Date, format: yyyy-MM-dd HH:mm:ss Postfields
start_version string YES A start version, format: * 0.1, 1.0, 1.0.0, ... Postfields
end_version string NO A start version, format: * 0.1, 1.0, 1.0.0, ... Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "start_version": "string",
    "end_version": "string",
    "released": "bool",
    "from": {
        "date": "2026-11-21 01:23:41.962035",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "to": {
        "date": "2026-11-21 01:23:41.962322",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    }
}
                            
Create a project
admin
POST/admin/project
Create a new project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
name string YES The name of the project Postfields
id int YES The glory up-partner project id (sort of) Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "apiKey": "string",
    "created_at": {
        "date": "2026-11-21 01:23:41.963850",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "active": "bool"
}
                            
Remove a project
admin
DELETE/admin/project/{id}
Remove an existing project.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
id int The id of * project
Get project languages
admin
GET/admin/project/{projectId}/languages
Get a list of enabled languages in project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
Response example
                                [
    {
        "id": "int",
        "code": "string",
        "language_name": "string",
        "translationCountSum": "int",
        "keyCountSum": "int",
        "client_status": "bool"
    }
]
                            
Create project version
admin
POST/admin/project/{project}/version
Create a new version for project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of * project
Parameters for Request
Name data type required description format in
version string YES The version number Postfields
active bool YES If the version is active Postfields
Response example
                                {
    "id": "int",
    "version": "string",
    "active": "int",
    "last_translation_modification": "type unclear",
    "last_config_modification": "type unclear",
    "last_config_modified_hash": "type unclear",
    "major_version": "int",
    "minor_version": "int",
    "patch_version": "int",
    "language_modifications": "type unclear",
    "mark_as_deleted": "type unclear"
}
                            
Get project versions
admin
GET/admin/project/{projectId}/versions
Get a list of project versions
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
Response example
                                [
    {
        "id": "int",
        "version": "string",
        "active": "int",
        "last_translation_modification": "type unclear",
        "last_config_modification": "type unclear",
        "last_config_modified_hash": "type unclear",
        "major_version": "int",
        "minor_version": "int",
        "patch_version": "int",
        "language_modifications": "type unclear",
        "mark_as_deleted": "type unclear"
    }
]
                            
Update project version
admin
PUT/admin/project/{project}/version/{id}
Update an existing project version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of * project
id int The id of * version
Parameters for Request
Name data type required description format in
version string YES The version number Postfields
active boolean YES Is Version active? Postfields
Response example
                                {
    "id": "int",
    "version": "string",
    "active": "int",
    "last_translation_modification": "type unclear",
    "last_config_modification": "type unclear",
    "last_config_modified_hash": "type unclear",
    "major_version": "int",
    "minor_version": "int",
    "patch_version": "int",
    "language_modifications": "type unclear",
    "mark_as_deleted": "type unclear"
}
                            
Get branches by version of project
admin
GET/admin/project/{projectId}/{versionId}/branches
Get all branches of project by a given version
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
versionId int The id of * version
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "start_version": "string",
        "end_version": "string",
        "from": "date",
        "to": "date",
        "released": "bool"
    }
]
                            
Get project branches
admin
GET/admin/project/{projectId}/branches
Get all project branches
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
project int The id of * project
Response example
                                [
    {
        "name": "string",
        "id": "int"
    }
]
                            
Add project language
admin
PUT/admin/project/{projectId}/language
Add a language to the project.
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of * project
Parameters for Request
Name data type required description format in
id integer YES The language id Postfields
Response example
                                {
    "id": "int",
    "code": "string",
    "language_name": "string"
}
                            
Remove project language
admin
DELETE/admin/project/{projectId}/language
Remove language from project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of * project
Parameters for Request
Name data type required description format in
id integer YES The language id Postfields
Response example
                                {
    "id": "int",
    "name": "string",
    "apiKey": "string",
    "created_at": {
        "date": "2026-11-21 01:23:41.975934",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "languages": [
        {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    ],
    "active": "bool"
}
                            
Set last modified flag
admin
PUT/admin/project/{projectId}/{version}/modified
Update the last modified flag
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
version string The * version number
Response example
                                {
    "success": "bool"
}
                            
Get users by project
admin
GET/admin/project/{projectId}/users
Get a list of users for project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
URL Parameters for Request
Name data type description
projectId int The id of * project
Response example
                                [
    {
        "id": "int",
        "created_at": {
            "date": "2026-11-21 01:23:41.978560",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "projects": [
            {
                "id": "int",
                "name": "string",
                "apiKey": "string",
                "created_at": {
                    "date": "2026-11-21 01:23:41.980872",
                    "timezone_type": 3,
                    "timezone": "Europe\/Berlin"
                },
                "languages": [
                    {
                        "id": "int",
                        "code": "string",
                        "language_name": "string"
                    }
                ],
                "active": "bool"
            }
        ],
        "originLanguage": {
            "id": "int",
            "code": "string",
            "language_name": "string"
        }
    }
]
                            
Get all projects
admin
GET/admin/projects
Get a list of projects
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
Response example
                                [
    {
        "id": "int",
        "name": "string",
        "apiKey": "string",
        "created_at": {
            "date": "2026-11-21 01:23:41.984469",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "languages": [
            {
                "id": "int",
                "code": "string",
                "language_name": "string"
            }
        ],
        "active": "bool"
    }
]
                            
Remove project version
admin
DELETE/admin/project/{project}/version
Remove a version from project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of * project
Parameters for Request
Name data type required description format in
version string YES The version number Postfields
Response example
                                {
    "success": "bool"
}
                            
Update project active status
admin
POST/admin/project/{projectId}/status/active
1 = to activate, 0 = deactivate
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of project
Parameters for Request
Name data type required description format in
status int YES 1 = active, 0 = inactive Postfields
Response example
                                {
    "success": "bool",
    "projectActive": "bool"
}
                            
Update project client language status
admin
POST/admin/project/{projectId}/clientlanguage/{languageId}/status
1 = to activate, 0 = deactivate, language is activated for the whole world when set to 1
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
projectId int The id of project
languageId int The id of the language
Parameters for Request
Name data type required description format in
status int YES 1 = active, 0 = inactive Postfields
Response example
                                {
    "success": true,
    "requestedLanguage": {
        "id": null,
        "code": null,
        "language_name": null
    },
    "project": {
        "id": null,
        "name": null,
        "apiKey": null,
        "created_at": null,
        "languages": [],
        "active": true
    },
    "clientLanguage": {
        "language": {
            "id": null,
            "code": null,
            "language_name": null
        },
        "enabled_for_client": false
    }
}
                            
Clear server cache
admin
POST/admin/project/cache/invalidate/server
Clear only the server cache
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
projectId integer YES The project id Postfields
Response example
                                {
    "success": "bool"
}
                            
Clear server cache and invalidate cdn
admin
POST/admin/project/cache/invalidate/all
Clear cache on server and invalidate the cdn. ATTENTION: CDN invalidation can take some time
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
projectId integer YES The project id Postfields
Response example
                                {
    "success": "bool"
}
                            
Clear the cache for api routes
admin
POST/admin/project/cache/invalidate/apiroute
Clear only cache for api routes
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
apikey string YES The api key of your project
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
Parameters for Request
Name data type required description format in
projectId integer YES The project id Postfields
version string YES The version number Postfields
languageCode string YES The language code Postfields
Response example
                                {
    "success": "bool"
}
                            
Create a project news
admin
POST/admin/project/{project}/news
Create a new project news
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of project
Parameters for Request
Name data type required description format in
topic string YES The topic of the news Postfields
content string YES The content of the news Postfields
deadline datetime NO The deadline of the news Postfields
visible boolean NO The visibility of the news Postfields
Response example
                                {
    "id": "mixed",
    "topic": "mixed",
    "content": "string",
    "visible": "mixed",
    "created": "mixed",
    "deadline": {
        "date": "2026-11-21 01:23:41.990748",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "project_id": "type unclear",
    "project_name": "type unclear"
}
                            
Update a project news
admin
PUT/admin/project/{project}/news/{id}
Update an existing project news
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of project
id int The id of news
Parameters for Request
Name data type required description format in
topic string YES The topic of the news Postfields
content string YES The content of the news Postfields
deadline datetime NO The deadline of the news Postfields
visible boolean NO The visibility of the news Postfields
Response example
                                {
    "id": "mixed",
    "topic": "mixed",
    "content": "string",
    "visible": "mixed",
    "created": "mixed",
    "deadline": {
        "date": "2026-11-21 01:23:41.992891",
        "timezone_type": 3,
        "timezone": "Europe\/Berlin"
    },
    "project_id": "type unclear",
    "project_name": "type unclear"
}
                            
List project news
admin
GET/admin/project/{project}/news/limit/{limit}/{offset}
List all news of a project
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of project
limit int The limit of results
offset int The offset for paging
Response example
                                [
    {
        "id": "mixed",
        "topic": "mixed",
        "content": "string",
        "visible": "mixed",
        "created": "mixed",
        "deadline": {
            "date": "2026-11-21 01:23:41.994881",
            "timezone_type": 3,
            "timezone": "Europe\/Berlin"
        },
        "project_id": "type unclear",
        "project_name": "type unclear"
    }
]
                            
List project news for user
admin
GET/admin/project/usernews/limit/{limit}/{offset}
List only project news for user
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
limit int The limit of results
offset int The offset for paging
Delete a project news
admin
DELETE/admin/project/{project}/news/{id}
Delete an existing news
Request Headers
name data type required description
uppartnerId int YES The id of up partner user
auth-token string YES The generated auth token for user
Response HTTP Codes
Code Description
200 Returned when successful
400 Returned when request syntax is incorrect
URL Parameters for Request
Name data type description
project int The id of project
id int The id of news