> ## 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: README
> GET /settings/automation/tasks/{id}. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
GET /settings/automation/tasks/\{id}.
Tool ID: `zoho_crm_workflow_tasks_get_task_by_id`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_workflow_tasks_get_task_by_id',
{
"id": "id_123"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_workflow_tasks_get_task_by_id --input '{
"id": "id_123"
}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_workflow_tasks_get_task_by_id --json` for the complete live contract.
## Input reference
To retrieve automation tasks configured in your Zoho CRM organization
| Name | Type | Required | Default | Details |
| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.id` | `string` | Yes | — | The ID of the task to retrieve Maximum length: 20. |
| `payload.include_inner_details` | `"related_module.module_name" \| "related_module.plural_label" \| "related_module.singular_label" \| "display_value" \| "module.module_name" \| "module.plural_label" \| "module.singular_label"` | No | — | data needed Allowed: `related_module.module_name`, `related_module.plural_label`, `related_module.singular_label`, `display_value`, `module.module_name`, `module.plural_label`, `module.singular_label`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "To retrieve automation tasks configured in your Zoho CRM organization",
"properties": {
"id": {
"type": "string",
"description": "The ID of the task to retrieve",
"maxLength": 20
},
"include_inner_details": {
"type": "string",
"description": "data needed",
"enum": [
"related_module.module_name",
"related_module.plural_label",
"related_module.singular_label",
"display_value",
"module.module_name",
"module.plural_label",
"module.singular_label"
]
}
},
"required": [
"id"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ----------------------------------------------------- | ----------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Success response |
| `result.data.tasks` | `array` | No | — | Field: tasks Maximum items: 1. |
| `result.data.tasks[].created_time` | `string` | No | — | Field: created\_time Maximum length: 255. |
| `result.data.tasks[].lock_status` | `object` | No | — | Represents the lock status of a resource, indicating whether it is currently locked or not. |
| `result.data.tasks[].lock_status.locked` | `boolean` | No | — | Field: locked |
| `result.data.tasks[].editable` | `boolean` | No | — | Field: editable |
| `result.data.tasks[].module` | `object` | Yes | — | Contains information about a module, including labels and API names. |
| `result.data.tasks[].module.singular_label` | `string` | No | — | Field: singular\_label Maximum length: 255. |
| `result.data.tasks[].module.moduleName` | `string` | No | — | Field: moduleName Maximum length: 255. |
| `result.data.tasks[].module.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.tasks[].module.plural_label` | `string` | No | — | Field: plural\_label Maximum length: 255. |
| `result.data.tasks[].module.api_name` | `string` | Yes | — | Field: api\_name Maximum length: 255. |
| `result.data.tasks[].related_module` | `object \| null` | No | — | Describes a related module, with details about its labels, API name, and ID. |
| `result.data.tasks[].related_module.singular_label` | `string` | No | — | Field: singular\_label Maximum length: 255. |
| `result.data.tasks[].related_module.plural_label` | `string` | No | — | Field: plural\_label Maximum length: 255. |
| `result.data.tasks[].related_module.api_name` | `string` | No | — | Field: api\_name Maximum length: 255. |
| `result.data.tasks[].related_module.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.tasks[].related_module.module_name` | `string` | No | — | Field: module\_name Maximum length: 255. |
| `result.data.tasks[].deletable` | `boolean` | No | — | Field: deletable |
| `result.data.tasks[].source` | `string` | No | — | Field: source Maximum length: 255. |
| `result.data.tasks[].created_by` | `object` | No | — | Provides details about the creator of an entity, including their name and ID. |
| `result.data.tasks[].created_by.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.tasks[].created_by.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.tasks[].notify` | `boolean` | No | — | Field: notify |
| `result.data.tasks[].feature_type` | `string` | No | — | Field: feature\_type Maximum length: 255. |
| `result.data.tasks[].field_mappings` | `array` | Yes | — | Field: field\_mappings Maximum items: 20. |
| `result.data.tasks[].field_mappings[].display_value` | `string` | No | — | Field: display\_value Maximum length: 255. |
| `result.data.tasks[].field_mappings[].field` | `object` | No | — | Describes a field in a module, including its API name and identifier. |
| `result.data.tasks[].field_mappings[].field.api_name` | `string` | Yes | — | Field: api\_name Maximum length: 255. |
| `result.data.tasks[].field_mappings[].field.id` | `string` | Yes | — | Field: id Maximum length: 255. |
| `result.data.tasks[].field_mappings[].type` | `"static" \| "merge_field" \| "execution_time"` | Yes | — | Field: type Allowed: `static`, `merge_field`, `execution_time`. Maximum length: 255. |
| `result.data.tasks[].field_mappings[].value` | `string \| record \| array` | Yes | — | Field: value |
| `result.data.tasks[].modified_time` | `string` | No | — | Field: modified\_time Maximum length: 255. |
| `result.data.tasks[].associated` | `boolean` | No | — | Field: associated |
| `result.data.tasks[].modified_by` | `object` | No | — | Provides details about the individual who modified an entity, including their name and ID. |
| `result.data.tasks[].modified_by.name` | `string` | No | — | Field: name Maximum length: 255. |
| `result.data.tasks[].modified_by.id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.data.tasks[].name` | `string` | Yes | — | Field: name Maximum length: 255. |
| `result.data.tasks[].id` | `string` | No | — | Field: id Maximum length: 255. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Success response",
"properties": {
"tasks": {
"type": "array",
"description": "Field: tasks",
"maxItems": 1,
"items": {
"type": "object",
"description": "Describes tasks within the system, including metadata, status, fields, and associated entities.",
"properties": {
"created_time": {
"type": "string",
"description": "Field: created_time",
"maxLength": 255
},
"lock_status": {
"type": "object",
"description": "Represents the lock status of a resource, indicating whether it is currently locked or not.",
"properties": {
"locked": {
"type": "boolean",
"description": "Field: locked"
}
},
"additionalProperties": false
},
"editable": {
"type": "boolean",
"description": "Field: editable"
},
"module": {
"type": "object",
"description": "Contains information about a module, including labels and API names.",
"properties": {
"singular_label": {
"type": "string",
"description": "Field: singular_label",
"maxLength": 255
},
"moduleName": {
"type": "string",
"description": "Field: moduleName",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"plural_label": {
"type": "string",
"description": "Field: plural_label",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Field: api_name",
"maxLength": 255
}
},
"required": [
"api_name"
],
"additionalProperties": false
},
"related_module": {
"type": [
"object",
"null"
],
"description": "Describes a related module, with details about its labels, API name, and ID.",
"properties": {
"singular_label": {
"type": "string",
"description": "Field: singular_label",
"maxLength": 255
},
"plural_label": {
"type": "string",
"description": "Field: plural_label",
"maxLength": 255
},
"api_name": {
"type": "string",
"description": "Field: api_name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
},
"module_name": {
"type": "string",
"description": "Field: module_name",
"maxLength": 255
}
},
"additionalProperties": false
},
"deletable": {
"type": "boolean",
"description": "Field: deletable"
},
"source": {
"type": "string",
"description": "Field: source",
"maxLength": 255
},
"created_by": {
"type": "object",
"description": "Provides details about the creator of an entity, including their name and ID.",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"additionalProperties": false
},
"notify": {
"type": "boolean",
"description": "Field: notify"
},
"feature_type": {
"type": "string",
"description": "Field: feature_type",
"maxLength": 255
},
"field_mappings": {
"type": "array",
"description": "Field: field_mappings",
"maxItems": 20,
"items": {
"type": "object",
"description": "Defines mappings of fields, including display values, types, and associated fields.",
"properties": {
"display_value": {
"type": "string",
"description": "Field: display_value",
"maxLength": 255
},
"field": {
"type": "object",
"description": "Describes a field in a module, including its API name and identifier.",
"properties": {
"api_name": {
"type": "string",
"description": "Field: api_name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"type": {
"type": "string",
"description": "Field: type",
"maxLength": 255,
"enum": [
"static",
"merge_field",
"execution_time"
]
},
"value": {
"description": "Field: value",
"anyOf": [
{
"type": "string",
"description": "Field: value",
"maxLength": 255
},
{
"type": "object",
"description": "Field: value",
"additionalProperties": true
},
{
"type": "array",
"description": "Field: value",
"maxItems": 20,
"items": {
"type": "string",
"description": "Array item for field value",
"maxLength": 20
}
}
]
}
},
"required": [
"type",
"value"
],
"additionalProperties": false
}
},
"modified_time": {
"type": "string",
"description": "Field: modified_time",
"maxLength": 255
},
"associated": {
"type": "boolean",
"description": "Field: associated"
},
"modified_by": {
"type": "object",
"description": "Provides details about the individual who modified an entity, including their name and ID.",
"properties": {
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"additionalProperties": false
},
"name": {
"type": "string",
"description": "Field: name",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Field: id",
"maxLength": 255
}
},
"required": [
"field_mappings",
"module",
"name"
],
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## 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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)