Tolgee Octri Demo
POST/v2/projects/{projectId}/keys/info

Get information about localization keys

Retrieves information about specified localization keys, including key data, screenshots, and translations for selected languages. Provide the requested keys and at least one language tag in languageTags. Keys that are not found are omitted from the response.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 2 body fields
projectIdintegerrequired
The numeric identifier of the project containing the keys.
branchstringoptional
Limit the key lookup to this branch.

The keys to look up and language tags whose translations to return.

keysarray<object>required
The keys to retrieve. Each entry must include a non-empty `name`; `namespace` can further identify the key.
languageTagsarray<string>required
Tags to return language translations in

5 status codes
200Returns key information in the embedded `keys` collection, including the requested language translations and screenshots where available.
_embeddedobjectoptional
400Returned when the request is invalid, including when required fields are missing or `languageTags` is empty.
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 access to the requested resource is forbidden.
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 requested resource is not found.
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 for a malformed request, a 401 when the request is unauthenticated, a 403 when access is forbidden, and a 404 when the project or requested resource is not found. The projectId path parameter must identify the project. The keys and languageTags fields are required, each key entry must include a non-empty name, and languageTags must contain at least one value.