Tolgee Octri Demo
GET/v2/projects/{projectId}/languages/{languageId}/key/{keyId}/suggestion

List translation suggestions for a key

Lists translation suggestions for a key in a language within a project. Use filterState to limit results to selected suggestion states and sort to choose the sort order. Results are paginated; use page and size to paginate the results.

7 parameters
languageIdintegerrequired
The integer identifier of the language to retrieve suggestions for.
keyIdintegerrequired
The integer identifier of the key to retrieve suggestions for.
projectIdintegerrequired
The integer identifier of the project containing the language and key.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted and must be zero or greater.
Default:0
sizeintegeroptional
Number of suggestions per page. Defaults to 20 when omitted and must be at least 1.
Default:20
sortarray<string>optional
Sorting criteria in `property,(asc|desc)` format. Supports multiple criteria; sort order defaults to ascending.
filterStatearray<string>optional
Filter suggestions by state: ACTIVE, ACCEPTED, or DECLINED.

5 status codes
200Returns a page of suggestion objects with pagination metadata, including the current page number, page size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when a query 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 authentication is missing or 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
403Returned when you do not have permission to view suggestions.
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, language, or key 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 when a query parameter is invalid, a 401 when authentication is missing or invalid, a 403 when you lack permission, and a 404 when a referenced resource is not found. The page query parameter must be zero or greater, and the size query parameter must be at least 1. filterState accepts ACTIVE, ACCEPTED, or DECLINED; the languageId path parameter, keyId path parameter, and projectId path parameter must identify the requested resources.