User List

Use this API to list all trainees.

 

HTTP REQUEST

GET /user/user-list

QUERY STRING PARAMETERS

firstRecord
required		 integer First record to return. Default: 1
count
required		 integer Number of records to be returned starting from the first record
Default: 20, Max count limit: 50
q string filter data by user name, email. 
{
    "success": true,
    "data": {
        "response": {
            "acknowledgement": "Success",
            "data": {
                "userList": [
                    {
                        "userId": 2,
                        "firstName": "Rajesh",
                        "lastName": "Kumar",
                        "email": "admin@horizzon.com",
                        "countryCode": "+91",
                        "mobile": "+919876543210",
                        "uniqueId": "100001",
                        "role": "Admin"
                    }
                ],
                "totalRecords": 1
            },
            "error": {
                "code": "",
                "internal_message": "",
                "moreInfo": []
            }
        }
    }
}
Field Type Description
userId integer user ID
firstName string First Name
lastName string Last Name
email string Email Address
countryCode string geographical codes
countryCode string geographical codes
mobile string contact number
uniqueId string roll number
role integer the position
totalRecords integer recourd count
Code Description
1003 ‘Invalid firstRecord’
1004 ‘Invalid count’

For general error details, click here.