API Documentation

Get User List

The Get User List API retrieves a paginated list of users from the QEval system. This API supports filtering users by employee details, supervisor, role, status, location, partner, username, and email.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetUserList
Method POST
Sub Domains “app” or “ai”

1. API Headers

Every API call must include two-factor authentication by providing the following headers:

Header Type Description
Authorisation String Bearer <Generated_Token> (generated after successful login)
X-API-KEY String

<Your_Unique_API_Key> (generated after successful login)

Note: If unavailable, email Qeval@etechtexas.com.

2. Sample Request (Payload)

</> JSON 
{
    "PageNumber": 1,
    "EmpId": "0",
    "EmpSrId": "0",
    "SupervisorId": "-1",
    "RoleId": "-1",
    "Status": true,
    "LocationId": "0",
    "PartnerId": null,
    "UserName": null,
    "Email": "0",
    "PageSize": 10
}

Description for Request Parameters

S.No Name Type Description Is Required?
1 PageNumber Integer Page index for pagination (starts from 1) Yes
2 EmpId String Filter by Employee ID. Use “0” to retrieve all users No
3 EmpSrId String Filter by Employee Serial ID No
4 SupervisorId String Filter by Supervisor ID. Use “-1” for all supervisors No
5 RoleId String Filter by Role ID. Use “-1” for all roles No
6 Status Boolean User status. True for active users, False for inactive users Yes
7 LocationId String Filter by location. Use “0” for all locations No
8 PartnerId Integer Filter by partner ID No
9 UserName String Filter by username No
10 Email String Filter by email. Use “0” for all emails No
11 PageSize Integer Number of records to return per page Yes

3. Response Examples

Success

</> JSON 
[
    {
        "EmpSRId": 1023,
        "UserName": "john.doe",
        "Partner": "Partner A",
        "AlternateID": "EMP001",
        "Supervisor": "Jane Smith",
        "Location": "Dallas",
        "Role": "Agent",
        "TotalRecordsCount": 150
    }
]

Status Codes

Code Status Description
200 Success Returns the paginated list of users

Response Parameters

S.No Name Type Description
1 EmpSRId Integer Employee Serial ID
2 UserName String Username of the user
3 Partner String Associated partner name
4 AlternateID String Employee ID of the user
5 Supervisor String Supervisor name
6 Location String User location
7 Role String Assigned role
8 TotalRecordsCount Integer Total number of records matching the filter criteria

Failure

</> JSON 
{
    "Message": "The request is invalid."
}

Status Codes

Code Status Description
400 Bad Request Invalid request format
401 Unauthorised Invalid username/password
405 Method Not Allowed Requested method is not supported for the resource
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Server encountered an error

Notes

  • Authentication is mandatory for accessing this API.
  • The API supports server-side pagination.
  • Use PageNumber and PageSize together to navigate through result pages.
  • Use “0” or “-1” values where applicable to retrieve all records for that filter.
  • TotalRecordsCount indicates the total number of records available across all pages.
  • Multiple filters can be combined to narrow down the search results.
  • The API returns only users accessible to the authenticated user.

    ×

    Contact Us