Tolgee Octri Demo
GET/v2/administration/organizations

List server organizations

Lists server organizations with pagination, sorting, and optional search. Use search to filter the organizations, and use page and size to paginate the results. Results default to page 0, 20 organizations per page, sorted by name in ascending order.

4 parameters
pageintegeroptional
Zero-based page index. Must be 0 or greater. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of organizations per page. Must be at least 1. Defaults to 20 when omitted.
Default:20
sortarray<string>optional
Sorting criteria in `property,(asc|desc)` format; supports multiple criteria and defaults to `name,ASC` when omitted.
Default:["name,ASC"]
searchstringoptional
Text used to filter the organizations returned.

5 status codes
200Returns a page of organizations with pagination metadata, including the current page number, page size, total elements, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when a request parameter is invalid, such as a negative page index or a 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 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 access to server organizations 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 a requested resource was 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 indicates an invalid request, a 401 indicates missing or invalid authentication, and a 403 indicates forbidden access. A 404 indicates that a requested resource was not found; page must be at least 0 and size must be at least 1.