Zoho: Automation Task — workflow Tasks get Task By Id

← Workflow tasks operations · Get started

Operation zoho.gettaskbyid

Provider route: GET /crm/v8/settings/automation/tasks/{id}. 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"]["getTaskById"]>[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.getTaskById(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_task_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Maximum length: 20
query	object	Optional	Additional keys: not allowed
query.include_inner_details	string	Optional	One of: related_module.module_name, related_module.plural_label, related_module.singular_label, display_value, module.module_name, module.plural_label, module.singular_label

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 Automation Task — workflow Tasks get Task By Id — response body — tasks
$ (anyOf 2)	null	Alternative

Referenced models: Automation Task — workflow Tasks get Task By Id — response body — tasks

Schemas

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

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

Field	Type	Presence	Description and constraints
$	object	Root	Success response for retrieving a single automation task by ID. Contains the full task configuration including field_mappings, module, lock_status, and metadata. Additional keys: not allowed
tasks	array	Required within parent	Array containing exactly one task object matching the requested ID. Maximum items: 1
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

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

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.

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

Field	Type	Presence	Description and constraints
$	object	Root	Contains module metadata, including labels, API name, IDs, and optional module_name for related module contexts. Additional keys: not allowed
api_name	string	Required within parent	API name of the module used in API requests (e.g., Leads, Contacts, Deals). Maximum length: 255
id	string	Optional	Unique Zoho CRM module ID. Maximum length: 255
moduleName	string	Optional	Module display name (camelCase). Present on parent module objects only. Maximum length: 255
module_name	string	Optional	Module system name (snake_case). Present on related_module objects only. Maximum length: 255
plural_label	string	Optional	Plural display label of the module (e.g., Leads, Contacts). Maximum length: 255
singular_label	string	Optional	Singular display label of the module (e.g., Lead, Contact). Maximum length: 255

Create an Automation Task — request body — body tasks item field mappings item type static value array

Field	Type	Presence	Description and constraints
$	array	Root	Represents an array of string values used as the static value for multiselectpicklist fields, where each element corresponds to an available picklist option. Valid option labels are retrievable from the GET /settings/fields endpoint filtered by data_type=multiselectpicklist. Maximum items: 50 Minimum items: 1
$[]	string	Each item	A single picklist option string to include in the multi-select field value. Each entry corresponds to one selectable option as defined for the target field in Zoho CRM. Maximum length: 255

Policy, approvals and errors

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