Zoho CRM: Wizards Get All Wizards

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

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.

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

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.

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

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation