> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Workflow Configurations Get Workflow Configurations

> See which workflow triggers and actions a Zoho CRM module supports, with their limits. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

See which workflow triggers and actions a Zoho CRM module supports, with their limits.

> [!NOTE]
>
> Tool ID: `zoho_crm_workflow_configurations_get_workflow_configurations`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_workflow_configurations_get_workflow_configurations',
  {
    "module": "Leads"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_workflow_configurations_get_workflow_configurations --input '{
  "module": "Leads"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "workflow_configurations": {
      "related_triggers_details": [
        {
          "api_name": "Example",
          "module": {},
          "name": "Example"
        }
      ],
      "triggers": [
        {
          "api_name": "Example",
          "deprecated": true,
          "name": "Example"
        }
      ],
      "actions": [
        {
          "is_clickable": true,
          "associate_action": true,
          "limit_per_action": 1
        }
      ]
    }
  }
}
```

Use `deepline describe zoho_crm_workflow_configurations_get_workflow_configurations --json` for the latest machine-readable contract.

## Input reference

To retrieve the complete configuration metadata details for workflows.This includes the list of available triggers for the module, the actions supported for each trigger, and their limits and properties. 

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `"Leads"` | Yes | — | Specify the API name of the module whose workflow configuration metadata you want to retrieve. Allowed: `Leads`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "To retrieve the complete configuration metadata details for workflows.This includes the list of available triggers for the module, the actions supported for each trigger, and their limits and properties.&nbsp;",
    "properties": {
      "module": {
        "type": "string",
        "description": "Specify the API name of the module whose workflow configuration metadata you want to retrieve.",
        "enum": [
          "Leads"
        ]
      }
    },
    "required": [
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Indicates that the workflow configuration was retrieved successfully for the specified module. |
| `result.data.workflow_configurations` | `object` | No | — | Nested schema for workflow\_configurations |
| `result.data.workflow_configurations.related_triggers_details` | `array` | No | — | Field: related\_triggers\_details Maximum items: 4. |
| `result.data.workflow_configurations.related_triggers_details[].api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].module` | `object` | No | — | Nested schema for module |
| `result.data.workflow_configurations.related_triggers_details[].module.singular_label` | `string` | No | — | Field: singular\_label Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].module.plural_label` | `string` | No | — | Field: plural\_label Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].module.api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].module.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].module.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].triggers` | `array` | No | — | Field: triggers Maximum items: 4. |
| `result.data.workflow_configurations.related_triggers_details[].triggers[].api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].triggers[].deprecated` | `boolean` | No | — | Field: deprecated |
| `result.data.workflow_configurations.related_triggers_details[].triggers[].name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.workflow_configurations.related_triggers_details[].triggers[].scheduled_actions_supported` | `boolean` | No | — | Field: scheduled\_actions\_supported |
| `result.data.workflow_configurations.related_triggers_details[].triggers[].actions` | `array` | No | — | Field: actions Maximum items: 12. |
| `result.data.workflow_configurations.triggers` | `array` | No | — | Field: triggers Maximum items: 10. |
| `result.data.workflow_configurations.triggers[].api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.workflow_configurations.triggers[].deprecated` | `boolean` | No | — | Field: deprecated |
| `result.data.workflow_configurations.triggers[].name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.workflow_configurations.triggers[].scheduled_actions_supported` | `boolean` | No | — | Field: scheduled\_actions\_supported |
| `result.data.workflow_configurations.triggers[].actions` | `array` | No | — | Field: actions Maximum items: 12. |
| `result.data.workflow_configurations.actions` | `array` | No | — | Field: actions Maximum items: 12. |
| `result.data.workflow_configurations.actions[].is_clickable` | `boolean` | No | — | Field: is\_clickable |
| `result.data.workflow_configurations.actions[].associate_action` | `boolean` | No | — | Field: associate\_action |
| `result.data.workflow_configurations.actions[].limit_per_action` | `integer \| null` | No | — | Field: limit\_per\_action Format: `int32`. |
| `result.data.workflow_configurations.actions[].api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.workflow_configurations.actions[].supported_in_scheduled_action` | `boolean` | No | — | Field: supported\_in\_scheduled\_action |
| `result.data.workflow_configurations.actions[].name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.workflow_configurations.actions[].limit` | `integer` | No | — | Field: limit Format: `int32`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Indicates that the workflow configuration was retrieved successfully for the specified module.",
        "properties": {
          "workflow_configurations": {
            "type": "object",
            "description": "Nested schema for workflow_configurations",
            "properties": {
              "related_triggers_details": {
                "type": "array",
                "description": "Field: related_triggers_details",
                "maxItems": 4,
                "items": {
                  "type": "object",
                  "description": "Nested schema for related_triggers_details",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "Field: api_name",
                      "maxLength": 255
                    },
                    "module": {
                      "type": "object",
                      "description": "Nested schema for module",
                      "properties": {
                        "singular_label": {
                          "type": "string",
                          "description": "Field: singular_label",
                          "maxLength": 255
                        },
                        "plural_label": {
                          "type": "string",
                          "description": "Field: plural_label",
                          "maxLength": 255
                        },
                        "api_name": {
                          "type": "string",
                          "description": "Field: api_name",
                          "maxLength": 255
                        },
                        "name": {
                          "type": "string",
                          "description": "Field: name",
                          "maxLength": 255
                        },
                        "id": {
                          "type": "string",
                          "description": "Field: id",
                          "maxLength": 255
                        }
                      },
                      "additionalProperties": false
                    },
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "triggers": {
                      "type": "array",
                      "description": "Field: triggers",
                      "maxItems": 4,
                      "items": {
                        "type": "object",
                        "description": "Nested schema for triggers",
                        "properties": {
                          "api_name": {
                            "type": "string",
                            "description": "Field: api_name",
                            "maxLength": 255
                          },
                          "deprecated": {
                            "type": "boolean",
                            "description": "Field: deprecated"
                          },
                          "name": {
                            "type": "string",
                            "description": "Field: name",
                            "maxLength": 255
                          },
                          "scheduled_actions_supported": {
                            "type": "boolean",
                            "description": "Field: scheduled_actions_supported"
                          },
                          "actions": {
                            "type": "array",
                            "description": "Field: actions",
                            "maxItems": 12,
                            "items": {
                              "type": "string",
                              "description": "Field: actions",
                              "maxLength": 255
                            }
                          }
                        },
                        "additionalProperties": false
                      }
                    }
                  },
                  "additionalProperties": false
                }
              },
              "triggers": {
                "type": "array",
                "description": "Field: triggers",
                "maxItems": 10,
                "items": {
                  "type": "object",
                  "description": "Nested schema for triggers",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "Field: api_name",
                      "maxLength": 255
                    },
                    "deprecated": {
                      "type": "boolean",
                      "description": "Field: deprecated"
                    },
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "scheduled_actions_supported": {
                      "type": "boolean",
                      "description": "Field: scheduled_actions_supported"
                    },
                    "actions": {
                      "type": "array",
                      "description": "Field: actions",
                      "maxItems": 12,
                      "items": {
                        "type": "string",
                        "description": "Field: actions",
                        "maxLength": 255
                      }
                    }
                  },
                  "additionalProperties": false
                }
              },
              "actions": {
                "type": "array",
                "description": "Field: actions",
                "maxItems": 12,
                "items": {
                  "type": "object",
                  "description": "Nested schema for actions",
                  "properties": {
                    "is_clickable": {
                      "type": "boolean",
                      "description": "Field: is_clickable"
                    },
                    "associate_action": {
                      "type": "boolean",
                      "description": "Field: associate_action"
                    },
                    "limit_per_action": {
                      "type": [
                        "integer",
                        "null"
                      ],
                      "description": "Field: limit_per_action",
                      "format": "int32"
                    },
                    "api_name": {
                      "type": "string",
                      "description": "Field: api_name",
                      "maxLength": 255
                    },
                    "supported_in_scheduled_action": {
                      "type": "boolean",
                      "description": "Field: supported_in_scheduled_action"
                    },
                    "name": {
                      "type": "string",
                      "description": "Field: name",
                      "maxLength": 255
                    },
                    "limit": {
                      "type": "integer",
                      "description": "Field: limit",
                      "format": "int32"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.