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&metadataKey=yourMetadataKey&metadataValues=value1,value2,value3&page=1&size=10" 
-H "accept: */*"
-H "Authorization: xxxxxxxxxxxxxxxxxx"

Request Params#

Param	DataType	Required	Description
groupName	String	No	Search keyword for the Group Name
page	Number	No	Page number to get the particular page data `default value is 1`
size	Number	No	Number of chats per page `default value is 10`
licensekey	String	Yes	Licensekey for this group
metadataKey	String	No	Metadata key to search group. Eg: `metadataKey = yourMetadataKey`
metadataValues	String	No	Metadata values to search group `Use comma to pass multiple values` Eg: `metadataValues=value1,value2,value3`

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",
        "metaData": {
          "key1": "value1",
          "key2": "value2",
          "key3": "value3"
        }
      }
    ],
    "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"
}