Tolgee Octri Demo
GET/v2/organizations/{organizationId}/glossaries/{glossaryId}/termsWithTranslations

List glossary terms with translations

Lists glossary terms with their translations for a specified organization and glossary. Use search and languageTags to filter the terms and their translations, and page, size, and sort to control the paginated results.

7 parameters
organizationIdintegerrequired
The int64 identifier of the organization that owns the glossary.
glossaryIdintegerrequired
The int64 identifier of the glossary to retrieve terms from.
pageintegeroptional
Zero-based page index; must be 0 or greater. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of terms per page; must be at least 1. Defaults to 20 when omitted.
Default:20
sortarray<string>optional
Sorting criteria in `property,(asc|desc)` format; multiple criteria are supported, and the default sort order is ascending.
searchstringoptional
Search text used to filter glossary terms.
languageTagsarray<string>optional
Language tags used to filter the translations included with glossary terms.

5 status codes
200Returns a page of glossary terms with translations, along with pagination metadata including the page number, page size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when a query parameter is invalid, such as a page index below 0 or a page size below 1.
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 is not permitted to access the requested glossary data.
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 specified organization or glossary cannot be 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 is returned when the request is unauthenticated, and a 403 when the authenticated user cannot access the requested data. A 404 is returned when the organization or glossary cannot be found. The organizationId and glossaryId path parameters must identify an existing organization and glossary.