Tolgee Octri Demo
GET/v2/administration/users

List server users

Lists server users in a paginated result. Use search to filter the users and sort to control their ordering; the default sort is by name in ascending order. Use page and size to paginate the results.

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

5 status codes
200Returns a page of server users with pagination metadata, including the page number, page size, total user count, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when a query parameter contains an invalid value.
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 lacks server-administration access.
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 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, a 401 when the request is unauthenticated, a 403 when the authenticated user lacks server-administration access, and a 404 when the requested resource is not found. page must be zero or greater, and size must be at least 1.