> ## 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
> Retrieve email templates list. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.
Retrieve email templates list.
Tool ID: `zoho_crm_email_templates_get_templates`
## 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_email_templates_get_templates',
{
"module": "example",
"sort_by": "example",
"sort_order": "asc"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_email_templates_get_templates --input '{
"module": "example",
"sort_by": "example",
"sort_order": "asc"
}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_email_templates_get_templates --json` for the complete live contract.
## Input reference
Fetches a paginated list of email templates with support for filtering, sorting, and pagination. Use page/per\_page for pagination (default per\_page=20, max=100), sort\_by and sort\_order for sorting, and filters parameter for advanced filtering.
| Name | Type | Required | Default | Details |
| -------------------- | ----------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.module` | `string` | No | — | Module API name for filtering Maximum length: 255. |
| `payload.sort_by` | `string` | No | — | Field name to sort by Maximum length: 255. |
| `payload.sort_order` | `"asc" \| "desc"` | No | — | Sort order (ascending or descending) Allowed: `asc`, `desc`. |
| `payload.category` | `string` | No | — | Template category filter. Note: Allowed values are favorite \| created\_by\_me \| shared\_with\_me \| associated \| draft. Maximum length: 64. Pattern: `^(favorite\|created_by_me\|shared_with_me\|associated\|draft)$`. |
| `payload.filters` | `string` | No | — | JSON-stringified filter expression. See operation description for supported comparators and group\_operator. Maximum length: 10000. |
| `payload.per_page` | `integer` | No | — | Number of items per page (default = 20, max = 100) Format: `int32`. Minimum: 1. Maximum: 100. |
| `payload.page` | `integer` | No | — | Page number, starting at 1 Format: `int32`. Minimum: 1. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Fetches a paginated list of email templates with support for filtering, sorting, and pagination. Use page/per_page for pagination (default per_page=20, max=100), sort_by and sort_order for sorting, and filters parameter for advanced filtering.",
"properties": {
"module": {
"type": "string",
"description": "Module API name for filtering",
"maxLength": 255
},
"sort_by": {
"type": "string",
"description": "Field name to sort by",
"maxLength": 255
},
"sort_order": {
"type": "string",
"description": "Sort order (ascending or descending)",
"enum": [
"asc",
"desc"
]
},
"category": {
"type": "string",
"description": "Template category filter. Note: Allowed values are favorite | created_by_me | shared_with_me | associated | draft.",
"maxLength": 64,
"pattern": "^(favorite|created_by_me|shared_with_me|associated|draft)$"
},
"filters": {
"type": "string",
"description": "JSON-stringified filter expression. See operation description for supported comparators and group_operator.",
"maxLength": 10000
},
"per_page": {
"type": "integer",
"description": "Number of items per page (default = 20, max = 100)",
"minimum": 1,
"maximum": 100,
"format": "int32"
},
"page": {
"type": "integer",
"description": "Page number, starting at 1",
"minimum": 1,
"format": "int32"
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------------------------------------- | ------------------------------------------ | -------- | ------- | ------------------------------------------------------------------------ |
| `result.data` | `object` | Yes | — | Successful response for email templates retrieval |
| `result.data.merge_fields_metadata` | `object` | No | — | Metadata about available merge fields and variables for email templates |
| `result.data.merge_fields_metadata.variables` | `record` | Yes | — | Variables metadata (optional) |
| `result.data.merge_fields_metadata.modules` | `array` | Yes | — | List of modules with available merge fields Maximum items: 500. |
| `result.data.merge_fields_metadata.modules[].api_name` | `string` | Yes | — | API name of the module Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].name` | `string` | Yes | — | Internal name of the module Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].id` | `string` | Yes | — | Module ID Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].display_name` | `string` | Yes | — | Display name of the module Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].fields` | `array` | Yes | — | List of available merge fields in this module Maximum items: 1000. |
| `result.data.merge_fields_metadata.modules[].fields[].custom_field` | `boolean` | Yes | — | Whether this is a custom field |
| `result.data.merge_fields_metadata.modules[].fields[].api_name` | `string` | Yes | — | API name of the field Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].fields[].id` | `string` | Yes | — | Field ID Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].fields[].display_name` | `string` | Yes | — | Display name of the field Maximum length: 255. |
| `result.data.merge_fields_metadata.modules[].custom_module` | `boolean` | Yes | — | Whether this is a custom module |
| `result.data.email_templates` | `array` | Yes | — | List of email templates Maximum items: 100. |
| `result.data.email_templates[].created_time` | `string` | Yes | — | Template creation timestamp Format: `date-time`. |
| `result.data.email_templates[].modified_time` | `string` | Yes | — | Last modification timestamp Format: `date-time`. |
| `result.data.email_templates[].last_usage_time` | `string` | Yes | — | Last time template was used Format: `date-time`. |
| `result.data.email_templates[].category` | `"normal" \| "draft"` | Yes | — | Template category - normal or draft Allowed: `normal`, `draft`. |
| `result.data.email_templates[].folder` | `object` | Yes | — | Reference to a folder |
| `result.data.email_templates[].folder.name` | `string` | Yes | — | Folder name Maximum length: 255. |
| `result.data.email_templates[].folder.id` | `string` | Yes | — | Folder ID Maximum length: 255. |
| `result.data.email_templates[].module` | `object` | Yes | — | Reference to a module |
| `result.data.email_templates[].module.api_name` | `string` | Yes | — | API name of the module Maximum length: 255. |
| `result.data.email_templates[].module.id` | `string` | Yes | — | Module ID Maximum length: 255. |
| `result.data.email_templates[].created_by` | `object` | Yes | — | Reference to a user |
| `result.data.email_templates[].created_by.name` | `string` | Yes | — | User name Maximum length: 255. |
| `result.data.email_templates[].created_by.id` | `string` | Yes | — | User ID Maximum length: 255. |
| `result.data.email_templates[].modified_by` | `object` | Yes | — | Reference to a user |
| `result.data.email_templates[].modified_by.name` | `string` | Yes | — | User name Maximum length: 255. |
| `result.data.email_templates[].modified_by.id` | `string` | Yes | — | User ID Maximum length: 255. |
| `result.data.email_templates[].name` | `string` | Yes | — | Template name Maximum length: 75. Pattern: `^[A-Za-z0-9]{5}$`. |
| `result.data.email_templates[].id` | `string` | Yes | — | Template ID Maximum length: 255. |
| `result.data.email_templates[].editor_mode` | `"plain_text" \| "rich_text" \| "gallery"` | Yes | — | Editor mode used Allowed: `plain_text`, `rich_text`, `gallery`. |
| `result.data.email_templates[].favorite` | `boolean` | Yes | — | Whether template is marked as favorite |
| `result.data.email_templates[].attachments` | `array` | Yes | — | Attachments data Maximum items: 10. |
| `result.data.email_templates[].attachments[].static_attachment` | `object` | Yes | — | Static attachment details |
| `result.data.email_templates[].attachments[].static_attachment.file_name` | `string` | Yes | — | Name of the file Maximum length: 255. |
| `result.data.email_templates[].attachments[].static_attachment.file_id` | `string` | Yes | — | ID of the file Maximum length: 255. |
| `result.data.email_templates[].attachments[].id` | `string` | Yes | — | Attachment ID Maximum length: 255. |
| `result.data.email_templates[].attachments[].type` | `string` | Yes | — | Type of attachment Maximum length: 50. |
| `result.data.email_templates[].subject` | `string` | Yes | — | Email subject line Maximum length: 500. |
| `result.data.email_templates[].associated` | `boolean` | Yes | — | Whether template is associated with other components |
| `result.data.email_templates[].active` | `boolean` | Yes | — | Whether template is active |
| `result.data.email_templates[].consent_linked` | `boolean` | Yes | — | Whether consent is linked to this template |
| `result.data.email_templates[].last_version_statistics` | `object` | Yes | — | Statistics from the last version of the template |
| `result.data.email_templates[].last_version_statistics.tracked` | `integer` | Yes | — | Number of tracked emails sent Format: `int32`. |
| `result.data.email_templates[].last_version_statistics.delivered` | `integer` | Yes | — | Number of delivered emails Format: `int32`. |
| `result.data.email_templates[].last_version_statistics.opened` | `integer` | Yes | — | Number of opened emails Format: `int32`. |
| `result.data.email_templates[].last_version_statistics.bounced` | `integer` | Yes | — | Number of bounced emails Format: `int32`. |
The table shows the first 50 fields. Expand the raw schema below for every field.
This output schema is too large to embed without slowing the page. Get the complete live contract with `deepline tools get zoho_crm_email_templates_get_templates --json`.
## 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)