Users List

To retreive the all registered users list.

info

{api-base-url} can be obtained from the MirrorFly console.

HTTP request#

curl -X GET "https://{api-base-url}/api/v1/users/userList?name={samplename}&page={page}&size={size}&metadataKey={XXXXXXX}&metadataValues={XXXXXXX}&licenseKey={licenseKey}" 
-H "accept: */*" 
-H "Authorization: AuthToken"

Request Params#

Param	DataType	Required	Description
metadataKey	String	No	Metadata key to search user details
metadataValues	String	No	Metadata values to search user details `Use comma to pass multiple values`
name	String	No	Name is a Username search to get user details
page	Number	No	Page number to get the particular page data `default value is 1`
size	Number	No	Number of users per page `default value is 50`
licenseKey	String	Yes	licenseKey to get users

Responses#

If successful, this action returns a user resource in the response body.

{
  "status": 200,
  "data": {
    "userList": [
      {
        "image": "sampleimage",
        "mobileNumber": "99xxxxxx11",
        "nickName": "samplenickname",
        "email": "sample@gmail.com",
        "username": "99xxxxxx11",
        "userId" : "99xxxxxx11",
        "metaData": {
          // metadata key/value if any set
        },
        "thumbImage": "samplethumbimage"
      }
    ],
    "totalPages": 1,
    "totalRecords": 1
  },
  "message": "Data retrieved successfully"
}

Error#

In the case of an error, an error object like below is returned.

When the token passed in Headers is not given or expired

{
    "status": 401,
    "message": "Token Expired"
}

In the case of a Bad Request, an error message is returned

{
    "status": 400,
    "message": "Error Message"
}