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

List glossary terms

Lists glossary terms for the specified glossary. Use search and languageTags to filter the results, and page, size, and sort to control pagination and ordering.

7 parameters
organizationIdintegerrequired
The unique identifier of the organization that owns the glossary.
glossaryIdintegerrequired
The unique identifier of the glossary whose terms to list.
pageintegeroptional
Zero-based page index. 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 the format `property,(asc|desc)`. Defaults to ascending order when a direction is omitted; you can provide multiple criteria.
searchstringoptional
Text used to filter glossary terms.
languageTagsarray<string>optional
Language tags used to filter glossary terms.

5 status codes
200Returns a page of glossary terms with pagination metadata, including the page number, page size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when the request is invalid, including when `page` or `size` fails validation.
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 the authenticated user does not have permission to access the glossary.
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 organization or glossary 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 the request is invalid. A 401 is returned when authentication is missing or invalid. A 403 is returned when the authenticated user cannot access the glossary, and a 404 is returned when the organization or glossary is not found. The page query parameter must be zero or greater, and size must be at least 1.