Zoho: List Workflow Rules in your Zoho CRM Organization

← Workflow rules operations · Get started

Operation zoho.getworkflowrules

Provider route: GET /crm/v8/settings/automation/workflow_rules. 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"]["getWorkflowRules"]>[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.getWorkflowRules(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(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.page	integer	Optional	Format: int32 Minimum: 1
query.per_page	integer	Optional	Format: int32 Maximum: 200 Minimum: 1
query.module	string	Optional	Format: string
query.status_active	boolean	Optional
query.execute_on	string	Optional	Maximum length: 25
query.sort_order	string	Optional	One of: asc, desc
query.sort_by	string	Optional	One of: modified_time
query.include_inner_details	boolean	Optional
query.filter	string	Optional	Maximum length: 1000

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 List Workflow Rules in your Zoho CRM Organization — response body

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body

Schemas

101 more schemas are linked from the tables above, on the schema pages.

List Workflow Rules in your Zoho CRM Organization — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the paginated list response for workflow rules, containing an array of workflow rule objects and pagination metadata. Additional keys: not allowed
info	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — info
workflow_rules	array	Required within parent	Represents the array of workflow rule objects returned in the list response. Maximum items: 200
workflow_rules[]	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item

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

List Workflow Rules in your Zoho CRM Organization — response body — info

Field	Type	Presence	Description and constraints
$	object	Root	Represents the pagination metadata included in list response payloads, including the current page, records per page, total count, and whether more records exist. Additional keys: not allowed
count	JSON	Required within parent
count (anyOf 1)	integer	Alternative	Represents the total number of records matching the query. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Required within parent	Indicates whether more records exist beyond the current page.
page	JSON	Required within parent
page (anyOf 1)	integer	Alternative	Represents the current page number in the paginated response. Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Required within parent
per_page (anyOf 1)	integer	Alternative	Represents the number of records returned per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents the full configuration and metadata of a single workflow rule, including its trigger, conditions, actions, lock status, and audit timestamps. Additional keys: not allowed
category	string	Optional	Represents the classification category of the workflow rule. Maximum length: 255
conditions	array	Optional	Represents the array of condition objects that define the criteria for executing the actions of the workflow rule. Maximum items: 10
conditions[]	Model	Each item	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item conditions item
created_by	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by
created_time	string	Required within parent	Represents the ISO 8601 timestamp indicating when the system created this workflow rule. Format: date-time Maximum length: 255
deletable	boolean	Required within parent	Indicates whether the requesting user has permission to delete this workflow rule.
deprecated	boolean	Optional	Indicates whether this workflow rule is deprecated and should be migrated to a newer configuration.
description	JSON	Required within parent
description (anyOf 1)	string	Alternative	Represents the user-defined description of the workflow rule. Null if not set. Maximum length: 255
description (anyOf 2)	null	Alternative	Represents the user-defined description of the workflow rule. Null if not set. Maximum length: 255
editable	boolean	Required within parent	Indicates whether the requesting user has permission to edit this workflow rule.
execute_when	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when
id	string	Required within parent	Represents the unique ID of the workflow rule. Maximum length: 20
last_executed_time	JSON	Required within parent
last_executed_time (anyOf 1)	string	Alternative	Represents the ISO 8601 timestamp of the last time this workflow rule was triggered. Null if the rule has never been triggered. Format: date-time
last_executed_time (anyOf 2)	null	Alternative	Represents the ISO 8601 timestamp of the last time this workflow rule was triggered. Null if the rule has never been triggered. Format: date-time
lock	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock
modified_by	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by
modified_time	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item modified time
module	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item module
name	string	Required within parent	Represents the name of the workflow rule. Maximum length: 255
source	string	Required within parent	Represents the origin of the workflow rule. For example, **crm** for rules created through the CRM UI, or **API** for rules created through the API. Maximum length: 255
status	Model	Required within parent	Expand List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item status

Referenced models: List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item status, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item created by, 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 conditions item, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item execute when, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock, List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item modified time

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents the activation state of a workflow rule, indicating whether the rule is currently active. Additional keys: not allowed
active	boolean	Optional	Indicates whether the workflow rule is currently active. Possible values: true - The workflow rule is active and executes its configured actions when trigger conditions are met. false - The workflow rule is inactive and does not execute, even when trigger conditions are met.

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

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identity details of the CRM user who created or last modified the workflow rule. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the CRM user. Format: string
name	string	Optional	Represents the name of the CRM user who created or last modified the workflow rule. Format: string

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

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

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	string	Alternative	Represents a time offset specification combining a period label and a numeric magnitude, used in time-based workflow trigger configurations. Format: date-time Maximum length: 255
$ (anyOf 2)	null	Alternative	Represents a time offset specification combining a period label and a numeric magnitude, used in time-based workflow trigger configurations. Format: date-time Maximum length: 255

List Workflow Rules in your Zoho CRM Organization — response body — workflow rules item lock locked by id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identity of the CRM user who locked the workflow rule, including their display name and unique ID. Additional keys: not allowed
id	string	Optional	Represents the unique ID of the CRM user who locked the workflow rule. Format: string
name	string	Optional	Represents the name of the CRM user who locked the workflow rule. Format: string

Policy, approvals and errors

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