> ## 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 Custom View By Id. Zoho CRM Custom Views Get Custom View By Id reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline.
Get Custom View By Id.
Tool ID: `zoho_crm_custom_views_get_custom_view_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_custom_views_get_custom_view_by_id',
{
"id": "id_123",
"module": "example"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_custom_views_get_custom_view_by_id --input '{
"id": "id_123",
"module": "example"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"custom_views": [
{
"wrap_text": true,
"name": "Example",
"display_value": "example"
}
],
"info": {
"translation": {
"public_views": "example",
"other_users_views": "example",
"shared_with_me": "example",
"created_by_me": "example"
}
}
}
}
```
Use `deepline tools get zoho_crm_custom_views_get_custom_view_by_id --json` for the latest machine-readable contract.
## Input reference
Get a specific custom view of a module using custom view ID
| Name | Type | Required | Default | Details |
| ------------------------------- | ---------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.id` | `string` | Yes | — | custom view id Maximum length: 25. |
| `payload.module` | `string` | Yes | — | module name Maximum length: 25. |
| `payload.include_inner_details` | `"$..criteria.field.field_label" \| "$..criteria.field.ui_type"` | No | — | To include inner details of criteria and cross filters Allowed: `$..criteria.field.field_label`, `$..criteria.field.ui_type`. Maximum length: 25. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get a specific custom view of a module using custom view ID",
"properties": {
"id": {
"type": "string",
"description": "custom view id",
"maxLength": 25
},
"module": {
"type": "string",
"description": "module name",
"maxLength": 25
},
"include_inner_details": {
"type": "string",
"description": "To include inner details of criteria and cross filters",
"maxLength": 25,
"enum": [
"$..criteria.field.field_label",
"$..criteria.field.ui_type"
]
}
},
"required": [
"id",
"module"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Get a specific custom view of a module using custom view ID |
| `result.data.custom_views` | `array` | Yes | — | List of custom views Maximum items: 1. |
| `result.data.custom_views[].wrap_text` | `boolean` | No | — | Indicates if the Custom View is wrapped |
| `result.data.custom_views[].name` | `string` | No | — | Name of the Custom View Maximum length: 255. |
| `result.data.custom_views[].display_value` | `string` | No | — | Display Value of the Custom View Maximum length: 255. |
| `result.data.custom_views[].$modified_criteria` | `boolean` | No | — | Indicates if the criteria has been modified |
| `result.data.custom_views[].access_type` | `"shared" \| "public" \| "only_to_me"` | No | — | Access Type of the Custom View Allowed: `shared`, `public`, `only_to_me`. |
| `result.data.custom_views[].created_time` | `string` | No | — | Creation Time of the Custom View Format: `date-time`. |
| `result.data.custom_views[].modified_time` | `string` | No | — | Modification Time of the Custom View Format: `date-time`. |
| `result.data.custom_views[].last_accessed_time` | `string` | No | — | Last Accessed Time of the Custom View Format: `date-time`. |
| `result.data.custom_views[].system_name` | `string \| null` | No | — | System Name of the Custom View Maximum length: 255. |
| `result.data.custom_views[].category` | `"public_views" \| "other_users_views" \| "shared_with_me" \| "created_by_me"` | No | — | Category of the Custom View Allowed: `public_views`, `other_users_views`, `shared_with_me`, `created_by_me`. |
| `result.data.custom_views[].default` | `boolean` | No | — | Indicates if the Custom View is set as default |
| `result.data.custom_views[].system_defined` | `boolean` | No | — | Indicates if the Custom View is system defined |
| `result.data.custom_views[].locked` | `boolean` | No | — | Indicates if the Custom View is locked |
| `result.data.custom_views[].favorite` | `null \| integer` | No | — | Indicates if the Custom View is marked as favorite Format: `int32`. |
| `result.data.custom_views[].offline` | `boolean` | No | — | Indicates if the Custom View is available offline |
| `result.data.custom_views[].criteria` | `object` | No | — | Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators |
| `result.data.custom_views[].criteria.field` | `object` | Yes | — | Field reference for filter operations with minimal required properties |
| `result.data.custom_views[].criteria.field.id` | `string` | No | — | Field identifier (optional for filter operations) |
| `result.data.custom_views[].criteria.field.api_name` | `string` | Yes | — | Field API name for filter application. Supports relationship notation (e.g., 'Deals\_\_r.Stage') |
| `result.data.custom_views[].criteria.comparator` | `"equal" \| "not_equal" \| "like" \| "not_like" \| "starts_with" \| "ends_with" \| "contains" \| "not_contains" \| "include_all" \| "include_any" \| "exclude_all" \| "exclude_any" \| "greater_than" \| "greater_equal" \| "less_equal" \| "less_than" \| "in" \| "not_in"` | Yes | — | Comparison operator. Note: allowed\_groups.filters only supports 'in' for allowed\_values context. |
| `result.data.custom_views[].criteria.value` | `record` | Yes | — | — |
| `result.data.custom_views[].criteria.type` | `"merge_field" \| "value" \| "pre_defined" \| "field"` | No | — | Indicates if the value is a direct value or a system variable placeholder |
| `result.data.custom_views[].criteria.$disrupted` | `boolean` | No | — | Indicates whether the criterion is disrupted |
| `result.data.custom_views[].criteria.group` | `array` | Yes | — | Array of filter conditions to be grouped together with the specified logical operator |
| `result.data.custom_views[].criteria.group_operator` | `"AND" \| "OR" \| "and" \| "or"` | Yes | — | Logical operator to apply between filter conditions in the group |
| `result.data.custom_views[].cross_filters` | `array` | No | — | Cross Filters applied to the Custom View Minimum items: 0. Maximum items: 3. |
| `result.data.custom_views[].cross_filters[].include_objects` | `boolean` | No | — | Indicates if related records are to be included |
| `result.data.custom_views[].cross_filters[].relation` | `object` | No | — | Child relationship module information |
| `result.data.custom_views[].cross_filters[].relation.additionalProperties` | `unknown` | No | — | — |
| `result.data.custom_views[].cross_filters[].relation.api_name` | `string` | No | — | API name of the Child relationship module Maximum length: 255. |
| `result.data.custom_views[].cross_filters[].relation.id` | `string` | No | — | Id of the Child relationship module Maximum length: 20. |
| `result.data.custom_views[].cross_filters[].relation.$disrupted` | `boolean` | No | — | Display name of the related module |
| `result.data.custom_views[].cross_filters[].criteria` | `object` | No | — | Filter criteria for data selection supporting both simple field-based filters and complex grouped filters with logical operators |
| `result.data.custom_views[].cross_filters[].criteria.field` | `object` | Yes | — | Field reference for filter operations with minimal required properties |
| `result.data.custom_views[].cross_filters[].criteria.field.id` | `string` | No | — | Field identifier (optional for filter operations) |
| `result.data.custom_views[].cross_filters[].criteria.field.api_name` | `string` | Yes | — | Field API name for filter application. Supports relationship notation (e.g., 'Deals\_\_r.Stage') |
| `result.data.custom_views[].cross_filters[].criteria.comparator` | `"equal" \| "not_equal" \| "like" \| "not_like" \| "starts_with" \| "ends_with" \| "contains" \| "not_contains" \| "include_all" \| "include_any" \| "exclude_all" \| "exclude_any" \| "greater_than" \| "greater_equal" \| "less_equal" \| "less_than" \| "in" \| "not_in"` | Yes | — | Comparison operator. Note: allowed\_groups.filters only supports 'in' for allowed\_values context. |
| `result.data.custom_views[].cross_filters[].criteria.value` | `record` | Yes | — | — |
| `result.data.custom_views[].cross_filters[].criteria.type` | `"merge_field" \| "value" \| "pre_defined" \| "field"` | No | — | Indicates if the value is a direct value or a system variable placeholder |
| `result.data.custom_views[].cross_filters[].criteria.$disrupted` | `boolean` | No | — | Indicates whether the criterion is disrupted |
| `result.data.custom_views[].cross_filters[].criteria.group` | `array` | Yes | — | Array of filter conditions to be grouped together with the specified logical operator |
| `result.data.custom_views[].cross_filters[].criteria.group_operator` | `"AND" \| "OR" \| "and" \| "or"` | Yes | — | Logical operator to apply between filter conditions in the group |
| `result.data.custom_views[].shared_to` | `array \| null` | No | — | Information about users/groups the Custom View is shared with Maximum items: 250. |
| `result.data.custom_views[].shared_to[].name` | `string` | No | — | Name of the user/group Maximum length: 255. |
| `result.data.custom_views[].shared_to[].id` | `string` | Yes | — | ID of the user/group Maximum length: 20. |
| `result.data.custom_views[].shared_to[].type` | `"territories" \| "roles" \| "groups" \| "users"` | Yes | — | Type of share (user/group) Allowed: `territories`, `roles`, `groups`, `users`. |
| `result.data.custom_views[].shared_to[].subordinates` | `boolean \| null` | No | — | true if subordinates are included, false otherwise |
| `result.data.custom_views[].module` | `object` | No | — | Module information |
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_custom_views_get_custom_view_by_id --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)