Get all Workflow Rules

Parameters

• modulestring, optional

  To filter and fetch the Workflow rules for a specific module. This is the primary module where the Workflow rule is created.

• trigger_modulestring, optional

  To filter the Workflow rules based on the related module that triggers the Workflow rule. 
  Please note that if this parameter is passed, the module parameter is mandatory.

• execute_onstring, optional

  To filter the Workflow rules based on the record action that triggers them. Please note that if this parameter is passed, the module parameter is mandatory. The possible values include all the possible values of the execute_when.type key of the POST request.

• status_activeBoolean, optional

  To filter the Workflow rules based on whether they are active or inactive.
  Possible values: 
  true - Get only the active rules 
  false - Get only the inactive rules

• filterstring, optional

  To filter the Workflow rules by their name. Pass a JSON-formatted filter. For example: {"field": {"api_name": "name"}, "comparator": "contains", "value": "WF Name"} 
  Note: Make sure to encode the value of filter parameter before making the API call.

  • fieldJSON object

    The API name of the Workflow rule field to filter.

    • api_namestring

      The API name of the field. The only supported value is name.

  • comparatorstring

    The comparison operator. The only supported value is contains.

  • valuestring

    The value to compare against.

• pageinteger, optional

  To get the list of Workflow from a specific page. Default value is 1. Use this along with per_page for pagination.
  Possible values: Positive Integer values only.

• per_pageinteger, optional

  To fetch a limited number of Workflow rules per page. The default and the maximum possible value is 200.
  Possible values: Positive Integer values only.

• sort_orderstring, optional

  To sort the Workflow rules in ascending or descending order, based on the modified_field value.
  Possible values: asc, desc

• sort_bystring, optional

  To sort the Workflow rules based on a specific field.
  Possible values: modified_time

• include_inner_details Boolean, optional

  To include the inner details of the Workflow rules in the response. This gives the summary view of each workflow's conditions and actions. 
  Supported value: conditions,conditions.instant_actions,conditions.criteria_details,conditions.scheduled_actions
  Note: 
  If this parameter is passed, the module parameter is mandatory.
  You must pass the complete list of keys, separated by commas. Providing only some keys is not supported.

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 additional configuration 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

  An object containing 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.

Additional keys in Summary view

• conditionsJSON array

  Lists the conditions based on which the when the Workflow rule triggers, and the associated actions. Each contains:

  • instant_actionsJSON array

    List of instant actions to execute when the condition is met.

  • scheduled_actionsJSON array

    List of scheduled actions and their delay configurations.

  • criteria_detailsJSON object

    Contains the conditions on which the actions should be triggered.

  • idstring

    Represents the unique ID of the condition.

  • sequence_numberinteger

    The order in which the condition is evaluated.

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.

• REQUIRED_PARAM_MISSINGHTTP 400

  A required parameter is missing in the request. 
  ResolutionThe details object in the response contains information about the missing parameter. Ensure all required and dependent parameters are included. Refer to the Parameters section for details.

• INVALID_MODULEHTTP 400

  You have specified an invalid value for the module parameter.
  Resolution: Specify a valid module API name.

• 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.