Get list of emails held for moderation

Purpose

The API retrieves all the emails that are held for moderation in a particular group. 

OAuth Scope

Use the scope

ZohoMail.organization.groups.ALL (or) ZohoMail.organization.groups.READ

to generate the Authtoken.

ALL - Full access to groups.

READ - Read the details of the groups.

Request URL

Method: GET

https://mail.zoho.com/api/organization/{zoid}/groups/{zgid}/messages

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Organization Details API.
  • zgid* long
    • This key is used to identify the group from which the data has to be retrieved. This is generated during group addition.
    • This parameter can be retrieved from the Get all groups API.

Query Parameters

  • start int
    • This parameter specifies the starting index of emails to be fetched.
    • The default value is 1.
  • limit int
    • This parameter specifies the number of emails to be retrieved from the start value mentioned.
    • The maximum limit is 50.
  • searchKey string
    • This parameter specifies the criteria for searching emails.
    • You can can either search by from address or subject.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/60000****8002/groups/360000****8002/messages?start=0&limit=25" \
-X GET \
-H "Accept: application/json" \
-H "Authorization:Zoho-oauthtoken ***"

Sample Response

Copied{
    "status": {
        "code": 200,
        "description": "success"
    },
    "data": [
        {
            "sentDateInGMT": 1695344041000,
            "hasAttachment": 0,
            "size": 36,
            "returnPath": "<rebecca@zylker.com>",
            "sender": "rebecca@zylker.com",
            "subject": "paula",
            "messageId": "1695363844569000003",
            "fromAddress": "rebecca@zylker.com",
            "isSpam": false
        },
        {
            "sentDateInGMT": 1695343996000,
            "hasAttachment": 0,
            "size": 36,
            "returnPath": "<rebecca@zylker.com>",
            "sender": "rebecca@zylker.com",
            "subject": "paula",
            "messageId": "1695363808702000001",
            "fromAddress": "rebecca@zylker.com",
            "isSpam": false
        }
    ]
}