Zoho: Get all wizard configurations

Zoho wizards.getAllWizards: arguments, response, policy and SDK examples.

Operation zoho.getallwizards

Provider route: GET /crm/v8/settings/wizards. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["wizards"]["getAllWizards"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.wizards.getAllWizards(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.wizards.get_all_wizards(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`query`	object	Optional	Additional keys: not allowed
`query.module`	string	Optional	API name of the module (e.g. Leads, Contacts, Deals). Maximum length: 50

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Contains a list of wizard objects returned for the account. Additional keys: not allowed
`$ (anyOf 1).wizards`	array	Required within parent	Contains the list of wizards configured in the Zoho CRM organization. Maximum items: 25
`$ (anyOf 1).wizards[]`	object	Each item	Represents a wizard and its basic configuration details. Additional keys: not allowed
`$ (anyOf 1).wizards[].active`	boolean	Required within parent	Indicates whether the wizard is currently enabled. Possible values: true - The wizard is active and available for use. false - The wizard is inactive and not available for use.
`$ (anyOf 1).wizards[].containers`	array	Required within parent	Contains the list of containers within the wizard, each defining a layout and the screens through which users progress. Maximum items: 7
`$ (anyOf 1).wizards[].containers[]`	object	Each item	Represents a container that groups the layout and screens used within the wizard flow. Additional keys: not allowed
`$ (anyOf 1).wizards[].containers[].id`	string	Required within parent	Represents the unique identifier of the container. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].containers[].layout`	object	Required within parent	Represents the layout associated with the container, from which the wizard fields are sourced. Additional keys: not allowed
`$ (anyOf 1).wizards[].containers[].layout.display_label`	string	Required within parent	Represents the display label of the layout, localized based on the active language setting. Maximum length: 50
`$ (anyOf 1).wizards[].containers[].layout.id`	string	Required within parent	Represents the unique identifier of the layout. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].containers[].layout.name`	string	Required within parent	Name of the layout. Maximum length: 50
`$ (anyOf 1).wizards[].containers[].screens`	array	Required within parent	Contains the list of screens that define the step-by-step flow a user navigates within this container. Maximum items: 75
`$ (anyOf 1).wizards[].containers[].screens[]`	object	Each item	Represents a single screen within the container, defining one step in the wizard’s guided data-entry flow. Additional keys: not allowed
`$ (anyOf 1).wizards[].containers[].screens[].api_name`	string	Required within parent	Represents the programmatic name used to identify the screen in API requests and responses. Maximum length: 255
`$ (anyOf 1).wizards[].containers[].screens[].display_label`	string	Required within parent	Represents the display label of the screen, localized based on the active language setting. Maximum length: 255
`$ (anyOf 1).wizards[].containers[].screens[].id`	string	Required within parent	Represents the unique identifier of the screen. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].created_by`	JSON	Required within parent
`$ (anyOf 1).wizards[].created_by (anyOf 1)`	object	Alternative	Represents the user who originally created the wizard, including their identifier and display name. Additional keys: not allowed
`$ (anyOf 1).wizards[].created_by (anyOf 1).id`	string	Required within parent	Represents the unique numeric identifier of the user who created the wizard. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].created_by (anyOf 1).name`	string	Required within parent	Represents the full name of the user who created the wizard, as it appears in Zoho CRM. Maximum length: 255
`$ (anyOf 1).wizards[].created_by (anyOf 2)`	null	Alternative	Represents the user who originally created the wizard, including their identifier and display name. Additional keys: not allowed
`$ (anyOf 1).wizards[].created_by (anyOf 2).id`	string	Required within parent	Represents the unique numeric identifier of the user who created the wizard. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].created_by (anyOf 2).name`	string	Required within parent	Represents the full name of the user who created the wizard, as it appears in Zoho CRM. Maximum length: 255
`$ (anyOf 1).wizards[].created_time`	string	Required within parent	Represents the creation date and time of the wizard. Format: date-time
`$ (anyOf 1).wizards[].display_label`	string	Required within parent	Represents the display label of the wizard, localized based on the active language setting in the user’s CRM environment. Maximum length: 255
`$ (anyOf 1).wizards[].id`	string	Required within parent	Numeric unique identifier of the wizard. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].modified_by`	JSON	Required within parent
`$ (anyOf 1).wizards[].modified_by (anyOf 1)`	object	Alternative	Represents the details of the user who last modified the wizard. Additional keys: not allowed
`$ (anyOf 1).wizards[].modified_by (anyOf 1).id`	string	Required within parent	Represents the unique numeric identifier of the user who last modified the wizard. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].modified_by (anyOf 1).name`	string	Required within parent	Represents the full name of the user who last modified the wizard, as it appears in Zoho CRM. Maximum length: 255
`$ (anyOf 1).wizards[].modified_by (anyOf 2)`	null	Alternative	Represents the details of the user who last modified the wizard. Additional keys: not allowed
`$ (anyOf 1).wizards[].modified_by (anyOf 2).id`	string	Required within parent	Represents the unique numeric identifier of the user who last modified the wizard. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].modified_by (anyOf 2).name`	string	Required within parent	Represents the full name of the user who last modified the wizard, as it appears in Zoho CRM. Maximum length: 255
`$ (anyOf 1).wizards[].modified_time`	string	Required within parent	Represents the last modification date and time of the wizard. Format: date-time
`$ (anyOf 1).wizards[].module`	object	Required within parent	Represents the CRM module associated with the wizard. Refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource for valid values. Additional keys: not allowed
`$ (anyOf 1).wizards[].module.api_name`	string	Required within parent	API name of the module associated with the wizard. Maximum length: 255
`$ (anyOf 1).wizards[].module.id`	string	Required within parent	Numeric unique identifier of the module. Format: int64 Maximum length: 19
`$ (anyOf 1).wizards[].name`	string	Required within parent	Represents the unique name of the wizard used in API requests and responses. Maximum length: 30
`$ (anyOf 1).wizards[].portal_user_types`	JSON	Required within parent
`$ (anyOf 1).wizards[].portal_user_types (anyOf 1)`	array	Alternative	Contains the client portal user types associated with the wizard. Returns null if no portal user types are configured. Maximum items: 50
`$ (anyOf 1).wizards[].portal_user_types (anyOf 1)[]`	Model	Each item	Expand Get all wizard configurations — response body — wizards wizards item portal user types null item
`$ (anyOf 1).wizards[].portal_user_types (anyOf 2)`	null	Alternative	Contains the client portal user types associated with the wizard. Returns null if no portal user types are configured. Maximum items: 50
`$ (anyOf 1).wizards[].portal_user_types (anyOf 2)[]`	Model	Each item	Expand Get all wizard configurations — response body — wizards wizards item portal user types null item
`$ (anyOf 1).wizards[].profiles`	JSON	Required within parent
`$ (anyOf 1).wizards[].profiles (anyOf 1)`	array	Alternative	Contains the list of CRM profiles associated with the wizard. Returns null when no profiles are associated. Maximum items: 50
`$ (anyOf 1).wizards[].profiles (anyOf 1)[]`	Model	Each item	Expand Get all wizard configurations — response body — wizards wizards item profiles null item
`$ (anyOf 1).wizards[].profiles (anyOf 2)`	null	Alternative	Contains the list of CRM profiles associated with the wizard. Returns null when no profiles are associated. Maximum items: 50
`$ (anyOf 1).wizards[].profiles (anyOf 2)[]`	Model	Each item	Expand Get all wizard configurations — response body — wizards wizards item profiles null item
`$ (anyOf 1).wizards[].source`	string	Optional	Indicates the origin from which the wizard originates. Possible values: crm - Created natively within Zoho CRM. platform_plugin - Created via a Zoho platform plugin. marketplace_plugin - Created through a Zoho Marketplace plugin. Known values: crm, platform_plugin, marketplace_plugin Maximum length: 50
`$ (anyOf 2)`	null	Alternative

Referenced models: Get all wizard configurations — response body — wizards wizards item portal user types null item, Get all wizard configurations — response body — wizards wizards item profiles null item

Schemas

Get all wizard configurations — response body — wizards wizards item portal user types null item

Field	Type	Presence	Description and constraints
`$`	object	Root	Client portal associated with the wizard. Additional keys: not allowed
`display_label`	string	Required within parent	Represents the display label of the client portal, translated into the user's language where a translation is available. Maximum length: 255
`id`	string	Required within parent	Represents the unique numeric identifier of the client portal user type. Format: int64 Maximum length: 19
`name`	string	Required within parent	Internal name of the client portal. Maximum length: 255

Get all wizard configurations — response body — wizards wizards item profiles null item

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents a CRM profile associated with the wizard. Additional keys: not allowed
`display_label`	string	Optional	Represents the display label of the profile, translated into the user's language where a translation is available. Maximum length: 255
`id`	string	Required within parent	Numeric unique identifier of the profile. Format: int64 Maximum length: 19
`name`	string	Required within parent	Name of the profile. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getallwizards. Catalog operation: getAllWizards. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source

Report an issue with this page