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. 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 ********************
or
Path Params
Responses
🟢200OK
application/json
The descriptions, grouped by namespace and key. Only keys with a non-empty description are returned, with no fallback to en-US; a locale that has translations but no descriptions returns []. The response may be cached for up to 30 seconds.
{"common":{"SEARCH_TRANSLATIONS":{"description":"Placeholder text in the translation search box"},"SET_ACTIVE":{"description":"Button that makes the selected brand active"}}}