Tolgee Octri Demo
GET/v2/projects/{projectId}/keys/{id}

Get a localization key

Retrieves a localization key from a project by its ID. Use this operation to inspect the key's name and configuration, including its branch, namespace, description, and translation character limit.

2 parameters
idintegerrequired
The integer ID of the key to retrieve.
projectIdintegerrequired
The integer ID of the project containing the key.

5 status codes
200Returns the key object, including its ID and name, and available branch, custom values, description, maximum character limit, and namespace.
branchstringoptional
Branch of key
customobjectoptional
Custom values of the key
descriptionstringoptional
Description of key
idintegerrequired
Id of key record
maxCharLimitintegeroptional
Maximum character limit for translations of this key
namestringrequired
Name of key
namespacestringoptional
Namespace of key
400Returned when a path parameter is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to access the key.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or key does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when a path value is invalid. A 401 is returned when the request is unauthenticated, a 403 when the authenticated user lacks access, and a 404 when the project or key cannot be found. The id and projectId path parameters must identify the key and its project.