Tolgee Octri Demo
GET/v2/projects/{projectId}/users

List users with project access

Lists users who have permission to access a project. Use search and the filter parameters to narrow the results, and sort to set ordering criteria. Use page and size to paginate the results.

8 parameters
projectIdintegerrequired
The integer identifier of the project whose users you want to list.
pageintegeroptional
Zero-based page index. Must be 0 or greater. Defaults to 0 when omitted.
Default:0
sizeintegeroptional
Number of users 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. Sorts in ascending order by default.
searchstringoptional
Search term used to filter the project users.
filterIdarray<integer>optional
Filter results to users with the specified integer user IDs.
filterNotIdarray<integer>optional
Exclude users with the specified integer user IDs from the results.
filterAgencyarray<integer>optional
Filter results to users from the specified integer agency IDs.

5 status codes
200Returns a page of project users and pagination metadata, including the page number, page size, total number of users, and total pages.
_embeddedobjectoptional
pageobjectoptional
400Returned when the request or 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 not authorized.
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 list users for the project.
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 project 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 or query parameters are invalid; a 401 when the authenticated user is not authorized; a 403 when the authenticated user lacks permission; and a 404 when the project is not found. The projectId path parameter must identify an existing project.