Share this page

# Get list of users by query

## Description

Gets a list of users by using a query filter (available in versions 2020 SP3 and later).

You can also add an additional parameter (`"include=user-role"`) to return user project and project role assignments. This parameter is available in LoadRunner Enterprise 2023 and later. The user role response is supported as JSON only; XML is not currently supported.

## URL

Copy code
Get list of users by query

    /Admin/rest/v1/users?query={<QUERY_NAME>[“<YOUR_QUERY_VALUE>”]}

Copy code
Get list of users by query and include user roles

    /Admin/rest/v1/users?query={<QUERY_NAME>[“<YOUR_QUERY_VALUE>”]}&include=user-roles

## 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.

AdditionalData options that return the user's project and project role assignments when `&include=user-roles` is added to the query:

- UsersRoles. User role data.

  - Domain. The project's domain.

  - ProjectName. The project's name.

  - ProjectID. The project's ID.

  - Role. The name of the role assigned to the project user. For the list of roles available in the project, see the Users page in LoadRunner Enterprise Administration.

## 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

Request Examples
Copy code
Get list of users by query

    GET http://<LRE_Server>Admin/rest/v1/users?query={name["sa"]}
    Content-Type: application/xml
    Accept: application/xml
    Cookie: ADM_LWSSO={AdmLwssoCookie};

Copy code
Get list of users by query and include user role data

    GET http://<LRE_Server>Admin/rest/v1/users?query={name["sa"]}&include=user-roles
    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 project and role to user
Get user by ID
Get all users

Tips to improve your search results... LoadRunner Enterprise Administration REST API Reference LRE Admin REST API All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic(Undefined variable: _rscC_Basic_Variables.VersionLabel)