> ## 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: Wizards Get All Wizards

> List the wizards in your Zoho CRM account, optionally for one module. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the wizards in your Zoho CRM account, optionally for one module.

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

## 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_wizards_get_all_wizards',
  {
    "module": "example"
  },
);

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

### CLI

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

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_wizards_get_all_wizards --json` for the complete live contract.

## Input reference

This API is used to get all the wizards' basic information available in the CRM account. You can filter the response by providing the module name as a query parameter.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | No | — | Module in which the wizard has been created. Maximum length: 50. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "This API is used to get all the wizards' basic information available in the CRM account. You can filter the response by providing the module name as a query parameter.",
    "properties": {
      "module": {
        "type": "string",
        "description": "Module in which the wizard has been created.",
        "maxLength": 50
      }
    },
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response containing an array of wizard objects. |
| `result.data.wizards` | `array` | Yes | — | List of wizards configured. Maximum items: 25. |
| `result.data.wizards[].created_time` | `string` | Yes | — | Timestamp when the wizard was created. Format: `date-time`. |
| `result.data.wizards[].modified_time` | `string` | Yes | — | Timestamp when the wizard was last modified. Format: `date-time`. |
| `result.data.wizards[].display_label` | `string` | Yes | — | Translated (if available) display name of the wizard. Maximum length: 255. |
| `result.data.wizards[].portal_user_types` | `array` | Yes | — | Client portals associated with the wizard. Can be null if no portal user types are configured. Maximum items: 50. |
| `result.data.wizards[].portal_user_types[].display_label` | `string` | Yes | — | Translated (if available) display label of the client portal. Maximum length: 255. |
| `result.data.wizards[].portal_user_types[].name` | `string` | Yes | — | Internal name of the client portal. Maximum length: 255. |
| `result.data.wizards[].portal_user_types[].id` | `string` | Yes | — | Numeric unique identifier of the client portal. Maximum length: 19. |
| `result.data.wizards[].module` | `object` | Yes | — | Module associated with the wizard. |
| `result.data.wizards[].module.api_name` | `string` | Yes | — | API name of the module associated with the wizard. Maximum length: 255. |
| `result.data.wizards[].module.id` | `string` | Yes | — | Numeric unique identifier of the module. Maximum length: 19. |
| `result.data.wizards[].name` | `string` | Yes | — | Unique name of the wizard used in the API. Maximum length: 30. |
| `result.data.wizards[].modified_by` | `object` | Yes | — | User who last modified the wizard. |
| `result.data.wizards[].modified_by.name` | `string` | Yes | — | Name of the user who last modified the wizard. Maximum length: 255. |
| `result.data.wizards[].modified_by.id` | `string` | Yes | — | Numeric unique identifier of the user who last modified the wizard. Maximum length: 19. |
| `result.data.wizards[].profiles` | `array` | Yes | — | Profiles associated with the wizard. Maximum items: 50. |
| `result.data.wizards[].profiles[].name` | `string` | Yes | — | Name of the profile. Maximum length: 255. |
| `result.data.wizards[].profiles[].id` | `string` | Yes | — | Numeric unique identifier of the profile. Maximum length: 19. |
| `result.data.wizards[].profiles[].display_label` | `string` | No | — | Translated (if available) display label of the profile. Maximum length: 255. |
| `result.data.wizards[].active` | `boolean` | Yes | — | Indicates whether the wizard is currently enabled. |
| `result.data.wizards[].containers` | `array` | Yes | — | Containers within the wizard that define layout and screens. Maximum items: 7. |
| `result.data.wizards[].containers[].layout` | `object` | Yes | — | The layout from which the wizard fields are sourced. |
| `result.data.wizards[].containers[].layout.name` | `string` | Yes | — | Name of the layout. Maximum length: 50. |
| `result.data.wizards[].containers[].layout.display_label` | `string` | Yes | — | Translated (if available) label of the layout, if available. Maximum length: 50. |
| `result.data.wizards[].containers[].layout.id` | `string` | Yes | — | Numeric unique identifier of the layout. Maximum length: 19. |
| `result.data.wizards[].containers[].screens` | `array` | Yes | — | Screens that make up the wizard flow within this container. Maximum items: 75. |
| `result.data.wizards[].containers[].screens[].api_name` | `string` | Yes | — | API name of the screen. Maximum length: 255. |
| `result.data.wizards[].containers[].screens[].id` | `string` | Yes | — | Numeric unique identifier of the screen. Maximum length: 19. |
| `result.data.wizards[].containers[].screens[].display_label` | `string` | Yes | — | Translated display label of the screen. Maximum length: 255. |
| `result.data.wizards[].containers[].id` | `string` | Yes | — | Numeric unique identifier of the container. Maximum length: 19. |
| `result.data.wizards[].id` | `string` | Yes | — | Numeric unique identifier of the wizard. Maximum length: 19. |
| `result.data.wizards[].created_by` | `object` | Yes | — | User who created the wizard. |
| `result.data.wizards[].created_by.name` | `string` | Yes | — | Name of the user who created the wizard. Maximum length: 255. |
| `result.data.wizards[].created_by.id` | `string` | Yes | — | Numeric unique identifier of the user who created the wizard. Maximum length: 19. |
| `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": "Response containing an array of wizard objects.",
        "properties": {
          "wizards": {
            "type": "array",
            "description": "List of wizards configured.",
            "maxItems": 25,
            "items": {
              "type": "object",
              "description": "Wizard with basic configuration details.",
              "properties": {
                "created_time": {
                  "type": "string",
                  "description": "Timestamp when the wizard was created.",
                  "format": "date-time"
                },
                "modified_time": {
                  "type": "string",
                  "description": "Timestamp when the wizard was last modified.",
                  "format": "date-time"
                },
                "display_label": {
                  "type": "string",
                  "description": "Translated (if available) display name of the wizard.",
                  "maxLength": 255
                },
                "portal_user_types": {
                  "type": "array",
                  "description": "Client portals associated with the wizard. Can be null if no portal user types are configured.",
                  "maxItems": 50,
                  "items": {
                    "type": "object",
                    "description": "Client portal associated with the wizard.",
                    "properties": {
                      "display_label": {
                        "type": "string",
                        "description": "Translated (if available) display label of the client portal.",
                        "maxLength": 255
                      },
                      "name": {
                        "type": "string",
                        "description": "Internal name of the client portal.",
                        "maxLength": 255
                      },
                      "id": {
                        "type": "string",
                        "description": "Numeric unique identifier of the client portal.",
                        "maxLength": 19
                      }
                    },
                    "required": [
                      "display_label",
                      "name",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "module": {
                  "type": "object",
                  "description": "Module associated with the wizard.",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "API name of the module associated with the wizard.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Numeric unique identifier of the module.",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "api_name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "name": {
                  "type": "string",
                  "description": "Unique name of the wizard used in the API.",
                  "maxLength": 30
                },
                "modified_by": {
                  "type": "object",
                  "description": "User who last modified the wizard.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the user who last modified the wizard.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Numeric unique identifier of the user who last modified the wizard.",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "profiles": {
                  "type": "array",
                  "description": "Profiles associated with the wizard.",
                  "maxItems": 50,
                  "items": {
                    "type": "object",
                    "description": "Profile associated with the wizard.",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Name of the profile.",
                        "maxLength": 255
                      },
                      "id": {
                        "type": "string",
                        "description": "Numeric unique identifier of the profile.",
                        "maxLength": 19
                      },
                      "display_label": {
                        "type": "string",
                        "description": "Translated (if available) display label of the profile.",
                        "maxLength": 255
                      }
                    },
                    "required": [
                      "name",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "active": {
                  "type": "boolean",
                  "description": "Indicates whether the wizard is currently enabled."
                },
                "containers": {
                  "type": "array",
                  "description": "Containers within the wizard that define layout and screens.",
                  "maxItems": 7,
                  "items": {
                    "type": "object",
                    "description": "Container that holds the layout and screens used in the wizard.",
                    "properties": {
                      "layout": {
                        "type": "object",
                        "description": "The layout from which the wizard fields are sourced.",
                        "properties": {
                          "name": {
                            "type": "string",
                            "description": "Name of the layout.",
                            "maxLength": 50
                          },
                          "display_label": {
                            "type": "string",
                            "description": "Translated (if available) label of the layout, if available.",
                            "maxLength": 50
                          },
                          "id": {
                            "type": "string",
                            "description": "Numeric unique identifier of the layout.",
                            "maxLength": 19
                          }
                        },
                        "required": [
                          "name",
                          "display_label",
                          "id"
                        ],
                        "additionalProperties": false
                      },
                      "screens": {
                        "type": "array",
                        "description": "Screens that make up the wizard flow within this container.",
                        "maxItems": 75,
                        "items": {
                          "type": "object",
                          "description": "Screen associated with this container.",
                          "properties": {
                            "api_name": {
                              "type": "string",
                              "description": "API name of the screen.",
                              "maxLength": 255
                            },
                            "id": {
                              "type": "string",
                              "description": "Numeric unique identifier of the screen.",
                              "maxLength": 19
                            },
                            "display_label": {
                              "type": "string",
                              "description": "Translated display label of the screen.",
                              "maxLength": 255
                            }
                          },
                          "required": [
                            "api_name",
                            "id",
                            "display_label"
                          ],
                          "additionalProperties": false
                        }
                      },
                      "id": {
                        "type": "string",
                        "description": "Numeric unique identifier of the container.",
                        "maxLength": 19
                      }
                    },
                    "required": [
                      "layout",
                      "screens",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "id": {
                  "type": "string",
                  "description": "Numeric unique identifier of the wizard.",
                  "maxLength": 19
                },
                "created_by": {
                  "type": "object",
                  "description": "User who created the wizard.",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Name of the user who created the wizard.",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Numeric unique identifier of the user who created the wizard.",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                }
              },
              "required": [
                "created_time",
                "modified_time",
                "display_label",
                "portal_user_types",
                "module",
                "name",
                "modified_by",
                "profiles",
                "active",
                "containers",
                "id",
                "created_by"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "wizards"
        ],
        "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.