> ## 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 inventory templates list. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Retrieve inventory templates list.
Tool ID: `zoho_crm_inventory_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_inventory_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_inventory_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_inventory_templates_get_templates --json` for the complete live contract.
## Input reference
Retrieve a paginated list of inventory templates with support for sorting, filtering, and category selection. Use page/per\_page for pagination (default: 20 per page, max: 200). Supports sorting by any field and filtering via JSON-stringified filter expressions.
| Name | Type | Required | Default | Details |
| -------------------- | --------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `payload.module` | `string` | No | — | Module API name. Maximum length: 128. |
| `payload.sort_by` | `string` | No | — | Field name to sort by (e.g., modified\_time, name) Maximum length: 50. |
| `payload.sort_order` | `"asc" \| "desc"` | No | — | Sort order; default is desc Allowed: `asc`, `desc`. |
| `payload.category` | `"normal" \| "draft"` | No | — | Filter by template category. Values: normal (active templates), draft (saved drafts) Allowed: `normal`, `draft`. |
| `payload.filters` | `string` | No | — | JSON-stringified filter expression. See operation description for supported comparators and group\_operator. Maximum length: 2000. |
| `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": "Retrieve a paginated list of inventory templates with support for sorting, filtering, and category selection. Use page/per_page for pagination (default: 20 per page, max: 200). Supports sorting by any field and filtering via JSON-stringified filter expressions.",
"properties": {
"module": {
"type": "string",
"description": "Module API name.",
"maxLength": 128
},
"sort_by": {
"type": "string",
"description": "Field name to sort by (e.g., modified_time, name)",
"maxLength": 50
},
"sort_order": {
"type": "string",
"description": "Sort order; default is desc",
"enum": [
"asc",
"desc"
]
},
"category": {
"type": "string",
"description": "Filter by template category. Values: normal (active templates), draft (saved drafts)",
"enum": [
"normal",
"draft"
]
},
"filters": {
"type": "string",
"description": "JSON-stringified filter expression. See operation description for supported comparators and group_operator.",
"maxLength": 2000
},
"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 containing inventory\_templates array and pagination info. |
| `result.data.inventory_templates` | `array` | Yes | — | List of inventory templates Maximum items: 100. |
| `result.data.inventory_templates[].created_time` | `string` | Yes | — | Template creation timestamp Format: `date-time`. |
| `result.data.inventory_templates[].modified_time` | `string` | Yes | — | Template last modification timestamp Format: `date-time`. |
| `result.data.inventory_templates[].last_usage_time` | `string \| null` | Yes | — | Last time the template was used Format: `date-time`. |
| `result.data.inventory_templates[].category` | `"normal" \| "draft"` | Yes | — | Template category: normal or draft Allowed: `normal`, `draft`. |
| `result.data.inventory_templates[].folder` | `object` | Yes | — | Folder reference with id and name. |
| `result.data.inventory_templates[].folder.name` | `string` | Yes | — | Name of the folder Maximum length: 255. |
| `result.data.inventory_templates[].folder.id` | `string` | Yes | — | ID of the folder Maximum length: 50. |
| `result.data.inventory_templates[].module` | `object` | Yes | — | Reference to a CRM module (api\_name and id). |
| `result.data.inventory_templates[].module.api_name` | `string` | Yes | — | API name of the module Maximum length: 50. |
| `result.data.inventory_templates[].module.id` | `string` | Yes | — | ID of the module Maximum length: 50. |
| `result.data.inventory_templates[].created_by` | `object` | Yes | — | User reference with id and display name. |
| `result.data.inventory_templates[].created_by.name` | `string` | Yes | — | Display name of the user Maximum length: 255. |
| `result.data.inventory_templates[].created_by.id` | `string` | Yes | — | ID of the user Maximum length: 50. |
| `result.data.inventory_templates[].modified_by` | `object` | Yes | — | User reference with id and display name. |
| `result.data.inventory_templates[].modified_by.name` | `string` | Yes | — | Display name of the user Maximum length: 255. |
| `result.data.inventory_templates[].modified_by.id` | `string` | Yes | — | ID of the user Maximum length: 50. |
| `result.data.inventory_templates[].name` | `string` | Yes | — | Template name (5-75 characters, alphanumeric) Maximum length: 75. Pattern: `^[A-Za-z0-9]{5}$`. |
| `result.data.inventory_templates[].id` | `string` | Yes | — | Unique template identifier Maximum length: 50. |
| `result.data.inventory_templates[].editor_mode` | `"plain_text" \| "rich_text" \| "gallery"` | Yes | — | Template editor mode Allowed: `plain_text`, `rich_text`, `gallery`. |
| `result.data.inventory_templates[].favorite` | `boolean` | Yes | — | Whether the template is marked as favorite |
| `result.data.info` | `object` | Yes | — | Pagination metadata for list responses (per\_page, page, count, more\_records). |
| `result.data.info.per_page` | `integer` | Yes | — | Items per page (requested or default) Format: `int32`. |
| `result.data.info.page` | `integer` | Yes | — | Current page number Format: `int32`. |
| `result.data.info.count` | `integer` | Yes | — | Number of items returned in `inventory_templates` for this response Format: `int32`. |
| `result.data.info.more_records` | `boolean` | Yes | — | True if there are more pages available after this one |
| `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": "Successful response containing inventory_templates array and pagination info.",
"properties": {
"inventory_templates": {
"type": "array",
"description": "List of inventory templates",
"maxItems": 100,
"items": {
"type": "object",
"description": "Inventory template summary object returned in lists.",
"properties": {
"created_time": {
"type": "string",
"description": "Template creation timestamp",
"format": "date-time"
},
"modified_time": {
"type": "string",
"description": "Template last modification timestamp",
"format": "date-time"
},
"last_usage_time": {
"type": [
"string",
"null"
],
"description": "Last time the template was used",
"format": "date-time"
},
"category": {
"type": "string",
"description": "Template category: normal or draft",
"enum": [
"normal",
"draft"
]
},
"folder": {
"type": "object",
"description": "Folder reference with id and name.",
"properties": {
"name": {
"type": "string",
"description": "Name of the folder",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the folder",
"maxLength": 50
}
},
"required": [
"name",
"id"
],
"additionalProperties": false
},
"module": {
"type": "object",
"description": "Reference to a CRM module (api_name and id).",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the module",
"maxLength": 50
},
"id": {
"type": "string",
"description": "ID of the module",
"maxLength": 50
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"created_by": {
"type": "object",
"description": "User reference with id and display name.",
"properties": {
"name": {
"type": "string",
"description": "Display name of the user",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the user",
"maxLength": 50
}
},
"required": [
"name",
"id"
],
"additionalProperties": false
},
"modified_by": {
"type": "object",
"description": "User reference with id and display name.",
"properties": {
"name": {
"type": "string",
"description": "Display name of the user",
"maxLength": 255
},
"id": {
"type": "string",
"description": "ID of the user",
"maxLength": 50
}
},
"required": [
"name",
"id"
],
"additionalProperties": false
},
"name": {
"type": "string",
"description": "Template name (5-75 characters, alphanumeric)",
"maxLength": 75,
"pattern": "^[A-Za-z0-9]{5}$"
},
"id": {
"type": "string",
"description": "Unique template identifier",
"maxLength": 50
},
"editor_mode": {
"type": "string",
"description": "Template editor mode",
"enum": [
"plain_text",
"rich_text",
"gallery"
]
},
"favorite": {
"type": "boolean",
"description": "Whether the template is marked as favorite"
}
},
"required": [
"created_time",
"modified_time",
"last_usage_time",
"category",
"folder",
"module",
"created_by",
"modified_by",
"name",
"id",
"editor_mode",
"favorite"
],
"additionalProperties": false
}
},
"info": {
"type": "object",
"description": "Pagination metadata for list responses (per_page, page, count, more_records).",
"properties": {
"per_page": {
"type": "integer",
"description": "Items per page (requested or default)",
"format": "int32"
},
"page": {
"type": "integer",
"description": "Current page number",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Number of items returned in `inventory_templates` for this response",
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "True if there are more pages available after this one"
}
},
"required": [
"per_page",
"page",
"count",
"more_records"
],
"additionalProperties": false
}
},
"required": [
"inventory_templates",
"info"
],
"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)