Purpose
The API retrieves details of all the groups in the organization.
Request URL
https://mail.zoho.com/api/organization/<zoid>/groups
Request Parameters
| Parameter | Data Type | Description |
| start | Integer | To retrieve the groups in a specific range. Specify the group index from which you want to retrieve here. Default value is 1 |
| limit | Integer | To retrieve a specific number of groups to display in the page, specify the count in this parameter. Default and the maximum value is 25. |
| searchKey | String | To get the details of group, which matches a specific SearchKey, specify the searchKey String in this parameter. |
| fields | String | By default all fields will be retrieved. To get only specific fields, specify the field names, separated by comma in this parameter. |
* - Mandatory parameter
Response Codes
Please refer Response Codes.
Sample Response
{
"status": {
"code": 200,
"description": "success"
},
"data": {
"groups": [{
"URI": " http://mail.zoho.com/api/organization/626162/groups/1037661",
"zgid": 1037661,
"streamsEnabled": true,
"name": "Marketing Group",
"iamGroupExist": true,
"mailGroupMemberList": [{
"memberEmailId": "rebecca@zylker.com",
"displayName": null,
"zuid": 841993,
"status": "confirmed",
"postApproval": "accept",
"ackStatus": false,
"role": "member"
}]
},
{
"URI": " http://mail.zoho.com/api/organization/626162/groups/1037668",
"zgid": 1037668,
"name": "Desingers",
"iamGroupExist": true,
"streamsEnabled": true,
"mailGroupMemberList": [{
"memberEmailId": "charles@zylker.com",
"displayName": null,
"zuid": 841993,
"status": "confirmed",
"postApproval": "accept",
"ackStatus": false,
"role": "member"
}]
},
{
"URI": " http://mail.zoho.com/api/organization/626162/groups/853476",
"zgid": 853476,
"name": "Movie",
"emailId": "moviegroup@zylker.com",
"iamGroupExist": true,
"streamsEnabled": false,
"accessType": "Organization",
"mailGroupMemberList": [{
"memberEmailId": "zombie@zylker.com.com",
"displayName": null,
"zuid": null,
"status": "confirmed",
"postApproval": "accept",
"ackStatus": true,
"role": "member"
}],
"groupGeneralSettings": {
"mailboxId": 1000000004001,
"subjectPrefix": "",
"replyTo": null,
"bounceThreshold": 15,
"notifSubscription": false
},
"groupAdminSettings": {
"mailboxId": 1000000004001,
"isNotToCc": false,
"memberPostApproval": false,
"nonMemberPostApproval": "default",
"orgMemberPostApproval": false,
"nonOrgMemberPostApproval": false,
"spamApproval": false,
"adminNotify": true,
"authorNotify": false,
"mailboxSendRights": false,
"spamMarkPermission": true,
"postApprovedNotify": false,
"suppressMailOnMemAdd": false
},
"groupTextSettings": {
"mailboxId": 1000000004001,
"subscriptionText": "test subs mc",
"unSubscriptionText": "You have been unsubscribed from the mailing list : ",
"rejectText": "Your mail was rejected due to Policy Violation.",
"autoResponseText": null,
"memberApprovalText": "Message has been waiting for moderator approval : ",
"adminMemberApprovalText": "As list administrator, your authorization is required for the following mailing list posting.<br>Reason : Member post awaits for approval ",
"adminNonMemberApprovalText": "As list administrator, your authorization is required for the following mailing list posting.<br>Reason : Post by Non-Member to the list ",
"ackStatusText": "Your message has been processed in the state of :",
"bounceText": "A message could not be delivered to its recipients :",
"isNotToOrCcText": "This message has been waiting for moderator approval.<br>Reason : listId is not present in the to or cc field ",
"spamApprovalText": "This message has been waiting for moderator approval.<br>Reason : Its a spam post ",
"groupMemberCount": 1
}
}
],
"domains": [
"zylker.com",
"zylkerapi.com"
],
"count": 4
}
}