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

List localization keys

Lists localization keys in a project, with page metadata and optional sorting and branch filtering. Use page and size to paginate the results; both have defaults, and page is zero-based. Sorting defaults to ascending by ID when omitted.

5 parameters
projectIdintegerrequired
The numeric identifier of the project whose keys to list.
pageintegeroptional
Zero-based page index. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of keys 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; you can provide multiple criteria. Defaults to ascending by ID when omitted.
Default:["id,ASC"]
branchstringoptional
Filter the keys by branch.

5 status codes
200Returns a page of localization 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 `page` or `size` 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. page must be zero or greater, and size must be at least 1.