> ## 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: Custom Views Get Custom Views

> List the custom views, or saved list filters, of a Zoho CRM module. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the custom views, or saved list filters, of a Zoho CRM module.

> [!NOTE]
>
> Tool ID: `zoho_crm_custom_views_get_custom_views`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_custom_views_get_custom_views',
  {
    "module": "example"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_custom_views_get_custom_views --input '{
  "module": "example"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "custom_views": [
      {
        "display_value": "example",
        "access_type": "shared",
        "category": "public_views",
        "default": true,
        "system_defined": true,
        "module": {
          "api_name": "Example",
          "id": "id_123"
        },
        "modified_by": {
          "id": "id_123",
          "name": "Example"
        },
        "created_by": {
          "id": "id_123",
          "name": "Example"
        },
        "id": "id_123"
      }
    ],
    "info": {
      "per_page": 123,
      "count": 123,
      "page": 123,
      "more_records": true,
      "default": "example",
      "translation": {
        "public_views": "example",
        "other_users_views": "example",
        "shared_with_me": "example",
        "created_by_me": "example"
      }
    }
  }
}
```

Use `deepline describe zoho_crm_custom_views_get_custom_views --json` for the latest machine-readable contract.

## Input reference

Get all custom views of a module

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | Yes | — | module name Maximum length: 25. |
| `payload.filters` | `object` | No | — | Parameter `filters` in `query`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get all custom views of a module",
    "properties": {
      "module": {
        "type": "string",
        "description": "module name",
        "maxLength": 25
      },
      "filters": {
        "type": "object",
        "description": "Parameter `filters` in `query`.",
        "anyOf": [
          {
            "type": "object",
            "description": "Simple field-based filter criterion with single field, comparator, and value",
            "properties": {
              "field": {
                "type": "object",
                "description": "Field reference for filter operations with minimal required properties",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Field identifier (optional for filter operations)",
                    "format": "int64"
                  },
                  "api_name": {
                    "type": "string",
                    "description": "Field API name for filter application. Supports relationship notation (e.g., 'Deals__r.Stage')",
                    "maxLength": 255
                  }
                },
                "required": [
                  "api_name"
                ],
                "additionalProperties": true
              },
              "comparator": {
                "type": "string",
                "description": "Comparison operator. Note: allowed_groups.filters only supports 'in' for allowed_values context.",
                "enum": [
                  "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"
                ]
              },
              "value": {
                "type": "object",
                "additionalProperties": true
              },
              "type": {
                "type": "string",
                "description": "Indicates if the value is a direct value or a system variable placeholder",
                "enum": [
                  "merge_field",
                  "pre_defined",
                  "value",
                  "field"
                ]
              }
            },
            "required": [
              "field",
              "comparator",
              "value"
            ],
            "additionalProperties": false
          },
          {
            "type": "object",
            "description": "Grouped filter criterion containing multiple filter conditions with logical operators for complex filtering logic",
            "properties": {
              "group": {
                "type": "array",
                "description": "Array of filter conditions to be grouped together with the specified logical operator",
                "minItems": 2,
                "maxItems": 25,
                "items": {
                  "type": "object",
                  "additionalProperties": true
                }
              },
              "group_operator": {
                "type": "string",
                "description": "Logical operator to apply between filter conditions in the group",
                "enum": [
                  "AND",
                  "OR",
                  "and",
                  "or"
                ]
              }
            },
            "required": [
              "group",
              "group_operator"
            ],
            "additionalProperties": false
          }
        ],
        "additionalProperties": true
      }
    },
    "required": [
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Get all custom views of a module |
| `result.data.custom_views` | `array` | Yes | — | List of custom views Maximum items: 200. |
| `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` | Yes | — | 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"` | Yes | — | 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"` | Yes | — | Category of the Custom View Allowed: `public_views`, `other_users_views`, `shared_with_me`, `created_by_me`. |
| `result.data.custom_views[].default` | `boolean` | Yes | — | Indicates if the Custom View is set as default |
| `result.data.custom_views[].system_defined` | `boolean` | Yes | — | 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` | Yes | — | Module information |

The table shows the first 50 fields. Expand the raw schema below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe zoho_crm_custom_views_get_custom_views --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](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.