Contacts List

To retreive the all phone book contacts list.


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

HTTP request#

curl -X GET "https://{api-base-url}/api/v1/contacts/contactsList?name={samplename}&page={page}&size={size}"
-H "accept: */*"
-H "Authorization: :AuthToken"

Request Params#

nameStringNoName is a Username search to get user details
pageNumberNoPage number to get the particular page data default value is 1
sizeNumberNoNumber of users per page default value is 50


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

"status": 200,
"data": {
"contactsList": [
"image": "sampleimage",
"thumbImage": "samplethumbimage",
"mobileNumber": "99xxxxxx11",
"nickName": "samplenickname",
"email": "",
"userId": "99xxxxxx11",
"isAdminBlocked": 0
"totalPages": 1,
"totalRecords": 1
"message": "Data retrieved successfully"


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"