GET - Organization Spam Listing Info


The API retrieves the Spam Listing Details, Blacklist/ Whitelist domains, and email addresses added for the entire organization by the administrator.

OAuth Scope

Use the scope ZohoMail.organization.spam.ALL (or) ZohoMail.organization.spam.READ to generate the Authtoken.

ALL - Full access to all spam details 

READ - Fetch the required spam info 

Request URL<zoid>/antispam/data

Path Parameters

Request Parameters

  • limitint, optional
    • This parameter is used to get the Spam listing details of the organization in batches. You need to specify the number of items to be retrieved in each batch.
    • The maximum allowed value is 500.
  • startint, optional
    • You can use this parameter to fetch the Spam listing details of the organization in batches. You need to specify the order number from which the data retrieval should start.
    • This parameter works better when used with the limit parameter.
  • spamCategorystring, mandatory
    • Use this parameter to specify the type of Spam Listing to be retrieved.
    • Supported values are:
      • whiteListEmail
      • spamEmail
      • rejectEmail
      • quarantineEmail
      • trustedEmail
      • whiteListDomain
      • spamDomain
      • rejectDomain
      • quarantineDomain
      • trustedDomain
      • whiteListIP
      • spamIP
      • rejectIP
      • quarantineIP
      • spamTLD
      • rejectTLD
      • quarantineTLD
      • recipientSpamEmail
      • recipientRejectEmail
      • recipientQuarantineEmail
  • modestring, mandatory
    • This is the parameter to denote the mode of action that is performed by the API.
    • Allowed Value: getMarkingData

Response Codes

Refer here for the response codes and their meaning.

Sample Request


Sample Response

    "status": {
        "code": 200,
        "description": "success"
    "data": {
        "whiteListEmail": [