Zoho: List automation task definitions with optional filters

← Workflow tasks operations · Get started

Operation zoho.getworkflowtasks

Provider route: GET /crm/v8/settings/automation/tasks. 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["workflowTasks"]["getWorkflowTasks"]>[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.workflowTasks.getWorkflowTasks(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.workflow_tasks.get_workflow_tasks(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.filter	string	Optional	Maximum length: 1000
query.feature_type	string	Optional	One of: workflow, approval_process, blueprint, kiosks, scoring_rule, case_escalation_rule, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, pathfinder, connected_workflows, commandcenter_service, cadences
query.module	string	Optional	Maximum length: 100
query.per_page	integer	Optional	Default: 200 Format: int32 Maximum: 200 Minimum: 1
query.page	integer	Optional	Default: 1 Format: int32 Minimum: 1
query.sort_by	string	Optional	One of: modified_time
query.sort_order	string	Optional	One of: desc, asc

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)	Model	Alternative	Expand List automation task definitions with optional filters — response body — info, tasks
$ (anyOf 2)	null	Alternative

Referenced models: List automation task definitions with optional filters — response body — info, tasks

Schemas

9 more schemas are linked from the tables above, on the schema pages.

List automation task definitions with optional filters — response body — info, tasks

Field	Type	Presence	Description and constraints
$	object	Root	Paginated response containing automation tasks and pagination metadata. Additional keys: not allowed
info	Model	Required within parent	Expand List automation task definitions with optional filters — response body — info, tasks info
tasks	array	Required within parent	List of automation task definitions for the current query page. Maximum items: 200
tasks[]	Model	Each item	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item

Referenced models: Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item, List automation task definitions with optional filters — response body — info, tasks info

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item

Field	Type	Presence	Description and constraints
$	object	Root	Automation task details returned by the API, including ownership, module context, and field mappings. Additional keys: not allowed
associated	boolean	Optional	Whether this task is associated with workflow/Blueprint/approval configuration.
created_by	Model	Optional	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item created by
created_time	string	Required within parent	Timestamp when the automation task was created. Maximum length: 255
deletable	boolean	Optional	Indicates whether this task can be deleted.
editable	boolean	Optional	Indicates whether this task can be edited by the current user/context.
feature_type	string	Required within parent	Specify the automation feature category that uses this task. Values: "workflow" (workflow rule), "approval_process" (Approval Process), "Blueprint" (Blueprint transition), "kiosks" (kiosk/process flow), "scoring_rule" (Scoring Rule), "case_escalation_rule" (case escalation rule). Known values: workflow, approval_process, blueprint, blueprint_transition, blueprint_state, review_process, orchestration, assignment_rules, kiosks, pathfinder, connected_workflows, commandcenter_service, cadences, scoring_rule, case_escalation_rule Maximum length: 255
field_mappings	array	Required within parent	Specify the field mappings configured for the task. When an automation task is created, the fields should be mapped to tasks modules. Use this JSON array to map the fields of Automation Tasks fields to create tasks automatically when an automation is triggered. Maximum items: 20
field_mappings[]	Model	Each item	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item
id	string	Required within parent	Unique ID of the automation task. Maximum length: 255
lock_status	Model	Optional	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item lock status
modified_by	Model	Optional	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item modified by
modified_time	string	Required within parent	Timestamp when the task definition was last modified. Maximum length: 255
module	Model	Required within parent	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module
name	string	Required within parent	Specify the name of the automation task. Maximum length: 255
notify	boolean	Optional	Whether owner notification is enabled for this task.
related_module	JSON	Optional	Related module metadata when the task is tied to a secondary module; otherwise null. Specify the api_name and id of the related module.
related_module (anyOf 1)	Model	Alternative	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module
related_module (anyOf 2)	null	Alternative	Null when no related module is associated with the task.
source	string	Optional	Source system that created or owns this task (for example: crm). Maximum length: 255

Referenced models: Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item created by, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item modified by, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item lock status, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item module

List automation task definitions with optional filters — response body — info, tasks info

Field	Type	Presence	Description and constraints
$	object	Root	Details about pagination for resource listings, such as count, page number, and if more records are available. Additional keys: not allowed
count	JSON	Optional
count (anyOf 1)	integer	Alternative	Number of records/actions returned in the current response page. Format: int32
count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_records	boolean	Optional	Indicates whether additional records/actions are available beyond the current page.
page	JSON	Optional
page (anyOf 1)	integer	Alternative	Current page number in the paginated result set (typically reflects the requested page value). Format: int32
page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_page	JSON	Optional
per_page (anyOf 1)	integer	Alternative	Maximum number of records/actions requested per page. Format: int32
per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item created by

Field	Type	Presence	Description and constraints
$	object	Root	Provides details about the creator of an entity, including their name and ID. Additional keys: not allowed
id	string	Optional	Unique Zoho CRM user ID of the creator. Maximum length: 255
name	string	Optional	Display name of the user who created this resource. Maximum length: 255

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item modified by

Field	Type	Presence	Description and constraints
$	object	Root	Provides details about the individual who modified an entity, including their name and ID. Additional keys: not allowed
id	string	Optional	Unique Zoho CRM user ID of the modifier. Maximum length: 255
name	string	Optional	Display name of the user who last modified this resource. Maximum length: 255

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents a single field-to-value mapping used within automation actions such as workflow tasks, create_record, add_meeting, and schedule_call. Each mapping identifies a target field via api_name or ID, declares a type discriminator that determines value interpretation, and supplies a value whose shape varies by type: static supplies a literal value, merge_field supplies a runtime-resolved token string, execution_time supplies a date or datetime offset object, and composite supplies structured participant data for the Events Participants field. The field_mappings array must include all fields the target module requires; omitting any produces a REQUIRED_DATA_NOT_FOUND error. discriminator: {"mapping": {"composite": "#/components/schemas/CompositeFieldMapping", "execution_time": "#/components/schemas/ExecutionTimeFieldMapping", "merge_field": "#/components/schemas/MergeFieldMapping", "static": "#/components/schemas/StaticFieldMapping"}, "propertyName": "type"}
$ (anyOf 1)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type static
$ (anyOf 2)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type merge field
$ (anyOf 3)	Model	Alternative	Expand Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time
$ (anyOf 4)	Model	Alternative	Expand Create an Automation Task — request body — body tasks item field mappings item type composite

Referenced models: Create an Automation Task — request body — body tasks item field mappings item type composite, Create an Automation Task — request body — body tasks item field mappings item type merge field, Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item field mappings item type execution time, Create an Automation Task — request body — body tasks item field mappings item type static

Automation Task — workflow Tasks get Task By Id — response body — tasks tasks item lock status

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lock status of a resource, indicating whether it is currently locked or not. Additional keys: not allowed
locked	boolean	Optional	Whether this automation task is locked from editing.

Policy, approvals and errors

SDK function policy ID: zoho.getworkflowtasks. Catalog operation: getWorkflowTasks. 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