Zoho: Get Workflow Rule Quota and Usage Counts

← Workflow rules operations · Get started

Operation zoho.getworkflowrulescount

Provider route: GET /crm/v8/settings/automation/workflow_rules/actions/rules_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"]["getWorkflowRulesCount"]>[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.getWorkflowRulesCount(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_workflow_rules_count(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed

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 Workflow Rule Quota and Usage Counts — response body

Referenced models: Get Workflow Rule Quota and Usage Counts — response body

Schemas

Get Workflow Rule Quota and Usage Counts — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body containing the organization-level workflow rule quota and current usage counts. Additional keys: not allowed
rules_count	object	Required within parent	Represents the workflow rule count and limit details for the organization. Additional keys: not allowed
rules_count.active_rules_configured	JSON	Required within parent
rules_count.active_rules_configured (anyOf 1)	integer	Alternative	Represents the number of currently active workflow rules configured in the organization. Format: int32
rules_count.active_rules_configured (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.active_rules_limit	JSON	Required within parent
rules_count.active_rules_limit (anyOf 1)	integer	Alternative	Represents the maximum number of active workflow rules allowed in the organization. Format: int32
rules_count.active_rules_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.active_rules_limit_per_module	JSON	Required within parent
rules_count.active_rules_limit_per_module (anyOf 1)	integer	Alternative	Represents the maximum number of active workflow rules allowed per CRM module. Format: int32
rules_count.active_rules_limit_per_module (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.rules_per_process_limit	JSON	Required within parent
rules_count.rules_per_process_limit (anyOf 1)	integer	Alternative	Represents the maximum number of workflow rules allowed per business process. Format: int32
rules_count.rules_per_process_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.scheduled_actions_per_rule_limit	JSON	Required within parent
rules_count.scheduled_actions_per_rule_limit (anyOf 1)	integer	Alternative	Represents the maximum number of scheduled action groups allowed per workflow rule. Format: int32
rules_count.scheduled_actions_per_rule_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.total_actions_per_rule_limit	JSON	Required within parent
rules_count.total_actions_per_rule_limit (anyOf 1)	integer	Alternative	Represents the maximum total number of actions (instant and scheduled combined) allowed per workflow rule. Format: int32
rules_count.total_actions_per_rule_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.total_rules_configured	JSON	Required within parent
rules_count.total_rules_configured (anyOf 1)	integer	Alternative	Represents the total number of workflow rules configured in the organization, including both active and inactive rules. Format: int32
rules_count.total_rules_configured (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.total_rules_limit	JSON	Required within parent
rules_count.total_rules_limit (anyOf 1)	integer	Alternative	Represents the maximum total number of workflow rules allowed in the organization. Format: int32
rules_count.total_rules_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rules_count.total_rules_limit_per_module	JSON	Required within parent
rules_count.total_rules_limit_per_module (anyOf 1)	integer	Alternative	Represents the maximum number of workflow rules allowed per CRM module. Format: int32
rules_count.total_rules_limit_per_module (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Policy, approvals and errors

SDK function policy ID: zoho.getworkflowrulescount. Catalog operation: getWorkflowRulesCount. 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