Zoho: Get Active and Total Workflow Rule Counts by Module

← Workflow rules operations · Get started

Operation zoho.getmodulespecificactionscount

Provider route: GET /crm/v8/settings/automation/workflow_rules/actions/module_specific_count. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["workflowRules"]["getModuleSpecificActionsCount"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.workflowRules.getModuleSpecificActionsCount(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.workflow_rules.get_module_specific_actions_count(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.module	string	Optional	Format: string

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Get Active and Total Workflow Rule Counts by Module — response body

Referenced models: Get Active and Total Workflow Rule Counts by Module — response body

Schemas

Get Active and Total Workflow Rule Counts by Module — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents an alternate response model containing the workflow rule counts aggregated by CRM module. Additional keys: not allowed
module_specific_count	array	Required within parent	Represents action counts broken down by CRM module. Maximum items: 500
module_specific_count[]	Model	Each item	Expand Get Active and Total Workflow Rule Counts by Module — response body — module specific count item

Referenced models: Get Active and Total Workflow Rule Counts by Module — response body — module specific count item

Get Active and Total Workflow Rule Counts by Module — response body — module specific count item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the workflow rule count details for a specific CRM module, including the number of active rules and total rules configured. Additional keys: not allowed
active_rules_configured	JSON	Required within parent
active_rules_configured (anyOf 1)	integer	Alternative	Represents number of currently active workflow rules configured. Format: int32
active_rules_configured (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
module	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
total_rules_configured	JSON	Required within parent
total_rules_configured (anyOf 1)	integer	Alternative	Represents total number of workflow rules configured (active + inactive). Format: int32
total_rules_configured (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM module or field reference using its API name and unique numeric ID. Minimum fields: 1 Additional keys: not allowed
api_name	string	Required within parent	Represents the API name of the module or field, such as **Leads**, **Contacts**, or a custom field API name. Maximum length: 100
id	string	Required within parent	Represents the unique numeric ID of the module or field. Maximum length: 20

Policy, approvals and errors

SDK function policy ID: zoho.getmodulespecificactionscount. Catalog operation: getModuleSpecificActionsCount. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source