Get Workflow Rules Limits

Purpose

To fetch the limit and usage details of workflow rules and actions in your Zoho CRM account. Use this API to track how many rules and actions are configured and how many more you can create.

Endpoints

  • GET /settings/automation/workflow_rules/actions/rules_count

Request Details

Request URL

{api-domain}/crm/{version}/settings/automation/workflow_rules/actions/rules_count

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/actions/rules_count"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-X GET

Response JSON

  • rules_countJSON object

    Contains the workflow rule limits and usage statistics.

    • scheduled_actions_per_rule_limitinteger

      Represents the maximum number of scheduled actions allowed in a single workflow rule.

    • total_rules_limitinteger

      Represents the maximum number of workflow rules allowed in the organization.

    • active_rules_configuredinteger

      Represents the number of workflow rules currently active in the organization.

    • rules_per_process_limitinteger

      Represents the maximum number of conditions allowed per automation process.

    • total_actions_per_rule_limitinteger

      Specifies the maximum number of actions that can be configured for each condition in a workflow rule, including both instant and scheduled actions.

    • total_rules_limit_per_moduleinteger

      Represents the maximum number of workflow rules allowed for a specific module.

    • active_rules_limitinteger

      Represents the maximum number of active workflow rules allowed in the organization.

    • total_rules_configuredinteger

      Represents the total number of workflow rules (active and inactive) currently configured in the org.

    • active_rules_limit_per_moduleinteger

      Represents the maximum number of active workflow rules allowed for a specific module.

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{
    "rules_count": {
        "scheduled_actions_per_rule_limit": 5,
        "total_rules_limit": 2500,
        "active_rules_configured": 30,
        "rules_per_process_limit": 10,
        "total_actions_per_rule_limit": 50,
        "total_rules_limit_per_module": 125,
        "active_rules_limit": 2000,
        "total_rules_configured": 34,
        "active_rules_limit_per_module": 75
    }
}