Groups List

To get the list of groups were the user is member of the group (or) to get the all list of groups associated with the admin login use the below API.

info

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

HTTP request#

curl -X GET "https://{api-base-url}/api/v1/group/groupList?licenseKey=samplelicenseKey&groupName=samplegroupname&page=1&size=10"
-H "accept: */*"
-H "Authorization: xxxxxxxxxxxxxxxxxx"

Request Params#

ParamDataTypeRequiredDescription
groupNameStringNoSearch keyword for the Group Name
pageNumberNoPage number to get the particular page data default value is 1
sizeNumberNoNumber of chats per page default value is 10
licensekeyStringYesLicensekey for this group

Responses#

If successful, this action returns the groups list.

{
"status": 200,
"data": {
"groupsList": [
{
"groupName": "samplegroupname",
"groupId": "samplegroupId",
"groupProfileImage": "XXXXXXXXXX",
"groupCreateDate": "dd/mm/yy hh:mm:ss"
}
],
"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 expired

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

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

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