Get translation descriptions for a locale

GET

/translations/descriptions/{locale}

Last modified:2026-10-06 19:38:14

OperationId:getTranslationDescriptions

Returns the translator descriptions for a locale, grouped by namespace and key. A description explains where a string appears, to help translators. Requires Reseller, Super User, or Super User Read Only scope.

Only keys with a non-empty description are returned, and there is no fallback to en-US. A locale that has translations but no descriptions returns an empty result, as []. A locale with no translations returns 404.

The response may be cached for up to 30 seconds. To set a description, use PUT /translations.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The descriptions, grouped by namespace and key.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/translations/descriptions/en-US' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Descriptions

{
    "common": {
        "SEARCH_TRANSLATIONS": {
            "description": "Placeholder text in the translation search box"
        },
        "SET_ACTIVE": {
            "description": "Button that makes the selected brand active"
        }
    }
}

Modified at 2026-10-06 19:38:14

Sync translations from locale files

List licenses