Tolgee Octri Demo
GET/v2/organizations

List organizations

Lists the organizations that the authenticated user is permitted to view. Use search and filterCurrentUserOwner to narrow the results, and page, size, and sort to control the returned page.

5 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; you can provide multiple criteria. Defaults to `id,ASC` when omitted.
Default:["id,ASC"]
filterCurrentUserOwnerbooleanoptional
Set to `true` to filter for organizations owned by the authenticated user.
searchstringoptional
Text used to filter the organizations returned.

5 status codes
200Returns a page of organizations under `_embedded.organizations`, with page metadata including the page number, 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 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 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 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 value is invalid; page must be at least 0 and size must be at least 1. A 401 indicates an unauthenticated request, a 403 indicates access is forbidden, and a 404 indicates a requested resource was not found. Use page and size to paginate the results.