Get group details

To get the details of a group use below API.

info

{your-domain-name} can be obtained from the MirrorFly console.

HTTP request#

curl -X GET "https://{your-domain-name}/api/v1/group/groupDetails?groupId=xxxxx"
-H "accept: */*"
-H "Authorization: xxxxxxxxxxxxxxxxxx"

Request Params#

ParamDataTypeRequiredDescription
groupIdStringYesId of the group to get its details

Responses#

If successful, this action returns vcard of the given groupId.

{
"status": 200,
"data": {
"vcards": {
"username": "Sample group name",
"lusername": "Sample group name",
"nickName": "Sample user",
"lnickName": "Sample user",
"fn": "First name",
"lfn": "First name",
"email": "sampleuser@gmail.com",
"lemail": "sampleuser@gmail.com",
"image": "sample image url",
"limage": "sample image url",
"isBlock": 0,
"family": "",
"lfamily": "",
"given": "",
"lgiven": "",
"middle": "",
"lmiddle": "",
"bday": "Date of birth",
"lbday": "Date of birth",
"ctry": "Country",
"lctry": "Country",
"locality": "Locality",
"llocality": "Locality",
"imageprivacy": "",
"limageprivacy": "",
"status": "1",
"lstatus": "",
"mobilenumber": "919612345678",
"lmobilenumber": "",
"orgname": "",
"lorgname": "",
"orgunit": "",
"lorgunit": "",
"designation": "",
"ldesignation": "",
"coverimg": "",
"lcoverimg": ""
}
},
"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"
}