Get a specific Workflow Rule

Purpose

To retrieve the details of a specific Workflow rule in your Zoho CRM account. This API returns the complete configuration of the Workflow rule, including its trigger type, conditions, and actions.

Endpoints

GET /settings/automation/workflow_rules/{workflow_rule_ID}

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/workflow_rules/{workflow_rule_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.workflow_rules.ALL
(or)
ZohoCRM.settings.workflow_rules.READ

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/automation/workflow_rules/4876876000011070001"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON

idstring
Unique ID of the Workflow rule.
namestring
Name of the Workflow rule.
descriptionstring
Description of the Workflow rule.
moduleJSON object
Details of the module with which the Workflow rule is associated. This object contains the unique ID and module API name.
execute_whenJSON object
The trigger type and its details for the Workflow rule.
- typestring
  The trigger type for the Workflow rule. E.g., create_or_edit, field_update.
- detailsJSON object
  This object contains additional configuration details based on the trigger type. This can include trigger_module, criteria, unit, period, repeat keys, depending on the type of trigger.
editableBoolean
This key denotes whether the Workflow rule can be edited or not.
deprecatedBoolean
This key denotes whether the Workflow rule is deprecated or not.
sourcestring
Represents the origin or creation method of the workflow rule.
Possible values: crm, platform_plugin, marketplace_plugin, zoho_flow_api
created_timedatetime
Timestamp when the Workflow rule was created.
created_byJSON object
Contains the details of the User who created the Workflow rule.
modified_timedatetime
Timestamp when the Workflow rule was last modified.
modified_byJSON object
Contains the details of the User who last modified the Workflow rule.
last_executed_timedatetime
The timestamp when the Workflow rule was last executed.
lockJSON object
Contains the locking details of the Workflow rule. This includes status, message and locked_by details.
statusJSON object
Denotes whether the Workflow rule is active or not.
categorystring
Category of the Workflow rule.
conditionsJSON array
List of conditions for triggering the Workflow rule.
- idstring
  Unique ID of the condition.
- sequence_numberinteger
  The order in which the condition will be evaluated and executed.
- criteria_detailsJSON object
  Contains the details of the criteria for evaluating the condition.
  - criteriaJSON object
    The primary criteria to match, to trigger the Workflow rule. The object contains the criteria details such as the field, comparator, and the type of value, and the value to compare with.
  - relational_criteriaJSON object
    The criteria defined on a related module that must be satisfied to trigger the Workflow rule. In addition to the fields in the main criteria, relational_criteria also includes:
    module - The related module in which the criteria is applied.
    module_selection - Indicates whether the rule applies to all records in the related module or only to records that meet specific conditions.
- instant_actionsJSON object
  The instant actions that are configured for the Workflow rule.
  - actionsJSON array
    This array contains the list of the instant actions configured for the Workflow rule. Each of these contain the related_details, name, id and type of action.
- scheduled_actionsJSON object
  The scheduled actions that are configured for the Workflow rule.
  - actionsJSON array
    This array contains the list of the scheduled actions configured for the Workflow rule.
  - execute_afterJSON object
    Defines the delay period between when the workflow rule is triggered and when the scheduled action should be executed. This specifies how long the system should wait after the trigger before performing the action.
  - idstring
    The unique identifier for the scheduled action.

Possible Errors

INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: This API supports only the GET method. Retry the request using the GET method.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have the required OAUTH SCOPE. Create a new token with valid scope. Refer to the Scope section for more details.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section for more details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team.

Sample Response

Copied{
    "workflow_rules": [
        {
            "created_time": "2025-07-03T11:24:19+05:30",
            "execute_when": {
                "details": {
                    "trigger_module": {
                        "api_name": "Emails",
                        "id": "4876876000000014163"
                    }
                },
                "type": "email_received"
            },
            "editable": true,
            "module": {
                "api_name": "Emails",
                "id": "4876876000000014163"
            },
            "deprecated": false,
            "deletable": true,
            "description": "Testing Scoring Rule Tigger",
            "source": "crm",
            "created_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "last_executed_time": null,
            "modified_time": "2025-07-03T11:24:19+05:30",
            "name": "Testing Scoring Rule Trigger",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "4876876000000327001"
            },
            "lock": {
                "locked_by": null,
                "message": null,
                "status": false
            },
            "id": "4876876000011070001",
            "category": "default",
            "conditions": [
                {
                    "sequence_number": 1,
                    "instant_actions": {
                        "actions": [
                            {
                                "related_details": null,
                                "name": "Test API",
                                "id": "4876876000010792012",
                                "type": "email_notifications"
                            }
                        ]
                    },
                    "scheduled_actions": [
                        {
                            "execute_after": {
                                "period": "business_days",
                                "unit": 1
                            },
                            "id": "4876876000011070016",
                            "actions": [
                                {
                                    "related_details": null,
                                    "name": "Follow up - ${Leads.Last Name} for ${Leads.Company}",
                                    "id": "4876876000000329771",
                                    "type": "tasks"
                                }
                            ]
                        }
                    ],
                    "criteria_details": {
                        "relational_criteria": {
                            "module_selection": "specific",
                            "criteria": {
                                "group_operator": "OR",
                                "group": [
                                    {
                                        "comparator": "equal",
                                        "field": {
                                            "api_name": "Lead_Source",
                                            "id": "4876876000000002609"
                                        },
                                        "type": "value",
                                        "value": [
                                            "Employee Referral",
                                            "Partner"
                                        ]
                                    },
                                    {
                                        "comparator": "greater_than",
                                        "field": {
                                            "api_name": "Final_Score",
                                            "id": "4876876000002752001"
                                        },
                                        "type": "value",
                                        "value": "15"
                                    }
                                ]
                            },
                            "module": {
                                "api_name": "Leads",
                                "id": "4876876000000002175"
                            }
                        },
                        "criteria": {
                            "comparator": "contains",
                            "field": {
                                "api_name": "Subject",
                                "id": "4876876000000014189"
                            },
                            "type": "value",
                            "value": "Urgent"
                        }
                    },
                    "id": "4876876000011070002"
                }
            ],
            "status": {
                "active": true
            }
        }
    ]
}