Get list of users by query
Available in versions: 2020 SP3 and later
Description
Gets a list of users by using a query filter.
URL
/Admin/rest/v1/users?query={<QUERY_NAME>[“<YOUR_QUERY_VALUE>”]}
Project Query Values
Below are the Query name options:
- ID. User's ID
- Name. User's name.
- FullName. User's full name.
- Email. User's email address.
Remarks
None
HTTP Method
GET: Returns a list of users according to the query.
Request
Headers:
Content-Type: application/xml
Accept: application/json, application/xml
Cookies:
ADM_LWSSO={AdmLwssoCookie};
Request Body:
None

GET http://<LRE_Server>Admin/rest/v1/users?query={name["sa"]}
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Response
Headers:
None
Cookies:
None
HTML Return Code:
One of the HTTP Return Codes.
HTML Body:
See User response.
See Also
Add a user
Update a user
Delete a user
Assign user to project and role
Get user by ID
Get all users