ZOzoho
agents

List all MailAgents

Retrieve a list of all Mail Agents in your CPaaS account.

get/mailagents

Request

  • Base URL
    https://cpaas.zoho.com/v1.1
  • Auth
    • OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.MailAgents.READ
    • or OAuth 2
      Authorization code: https://accounts.zoho.com/oauth/v2/auth
      Token URL: https://accounts.zoho.com/oauth/v2/token scopes: Zeptomail.MailAgents.ALL

Response

List of Mail Agents.

statusstring

Example response

{
  "data": [
    {
      "mailagent_name": "mailagent_1",
      "created_time": "04 Jun 2025 08:19 PM",
      "description": "Production mail agent",
      "mailagent_key": "123456abcd78",
      "status": "active"
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.