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

Search localization keys

Searches a project's localization keys by key name, base translation, or a translation in a specified language. Supply search and optionally set languageTag, branch, and pagination parameters to refine the results. Sorting criteria are ignored for this search.

7 parameters
projectIdintegerrequired
The numeric identifier of the project whose keys to search.
searchstringrequired
The query to match against key names, base translations, or translations in the selected language.
languageTagstringoptional
The language in which to search translations.
branchstringoptional
Limit the search to keys in this branch.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of results to return per page; must be at least 1. Defaults to 20 when omitted.
Default:20
sortarray<string>optional
Sorting criteria in `property,(asc|desc)` format. Sorting is ignored for this search.

5 status codes
200Returns a page of matching keys in the embedded `keys` collection, with metadata for the page number, page size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when the request is invalid, such as when `search` is missing or a pagination value is below its minimum.
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 requested project 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 is not found. The projectId path parameter must identify the project, and the search query parameter is required. page must be zero or greater, and size must be at least 1.