> ## 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: Fields Get Fields

> List the fields of a Zoho CRM module, with their types, labels and picklist values. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

List the fields of a Zoho CRM module, with their types, labels and picklist values.

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

## 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_fields_get_fields',
  {
    "module": "example",
    "include": "allowed_permissions_to_update"
  },
);

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

### CLI

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

## Example response

The static output schema lacks the details for a reliable example. Use `deepline describe zoho_crm_fields_get_fields --json` for the complete live contract.

## Input reference

Retrieve all fields metadata for modules. Examples and schemas derived from provided sample and schema files.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.module` | `string` | Yes | — | The API name of the module to which the field belongs. Maximum length: 30. |
| `payload.include` | `"allowed_permissions_to_update" \| "skip_field_permissionz"` | Yes | — | To include additional information about the field's permissions to update. Allowed: `allowed_permissions_to_update`, `skip_field_permissionz`. Maximum length: 50. |
| `payload.type` | `"all" \| "unused" \| "used"` | No | — | The usage type of the field. Allowed: `all`, `unused`, `used`. Maximum length: 10. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve all fields metadata for modules. Examples and schemas derived from provided sample and schema files.",
    "properties": {
      "module": {
        "type": "string",
        "description": "The API name of the module to which the field belongs.",
        "maxLength": 30
      },
      "include": {
        "type": "string",
        "description": "To include additional information about the field's permissions to update.",
        "maxLength": 50,
        "enum": [
          "allowed_permissions_to_update",
          "skip_field_permissionz"
        ]
      },
      "type": {
        "type": "string",
        "description": "The usage type of the field.",
        "maxLength": 10,
        "enum": [
          "all",
          "unused",
          "used"
        ]
      }
    },
    "required": [
      "module",
      "include"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response object containing an array of fields. |
| `result.data.fields` | `array` | Yes | — | An array of field metadata objects. Maximum items: 100. |
| `result.data.fields[].associated_module` | `record` | No | — | — |
| `result.data.fields[].webhook` | `boolean` | Yes | — | Wether webhook is enabled for the field |
| `result.data.fields[].operation_type` | `object` | Yes | — | Operation types allowed for the field |
| `result.data.fields[].operation_type.web_update` | `boolean` | Yes | — | Wether any operation is allowed through web update |
| `result.data.fields[].operation_type.api_create` | `boolean` | Yes | — | Wether any operation is allowed through API create |
| `result.data.fields[].operation_type.web_create` | `boolean` | Yes | — | Wether any operation is allowed through web create |
| `result.data.fields[].operation_type.api_update` | `boolean` | Yes | — | Wether any operation is allowed through API update |
| `result.data.fields[].colour_code_enabled_by_system` | `boolean` | Yes | — | Wether any colour code is enabled by system |
| `result.data.fields[].field_label` | `string` | Yes | — | Plural label of the module. Maximum length: 50. |
| `result.data.fields[].tooltip` | `record` | No | — | — |
| `result.data.fields[].display_format_properties` | `record` | No | — | — |
| `result.data.fields[].type` | `string` | Yes | — | Type of the field used or unused. Maximum length: 25. |
| `result.data.fields[].field_read_only` | `boolean` | Yes | — | Wether field is read only |
| `result.data.fields[].customizable_properties` | `record` | No | — | — |
| `result.data.fields[].display_label` | `string` | Yes | — | Display label of the field. Maximum length: 50. |
| `result.data.fields[].read_only` | `boolean` | Yes | — | Wether field is read only |
| `result.data.fields[].association_details` | `record` | Yes | — | — |
| `result.data.fields[].businesscard_supported` | `boolean` | Yes | — | Wether business card is supported for the field |
| `result.data.fields[].multi_module_lookup` | `record` | Yes | — | — |
| `result.data.fields[].id` | `string` | Yes | — | Id of the resource. Format: `int64`. |
| `result.data.fields[].created_time` | `record` | No | — | — |
| `result.data.fields[].filterable` | `boolean` | Yes | — | Indicates if the field is filterable |
| `result.data.fields[].visible` | `boolean` | Yes | — | Indicates if the field is visible |
| `result.data.fields[].profiles` | `array` | Yes | — | List of profiles associated with the field Maximum items: 50. |
| `result.data.fields[].profiles[].permission_type` | `string` | Yes | — | Type of permission granted Maximum length: 25. |
| `result.data.fields[].profiles[].name` | `string` | Yes | — | Name of the profile Maximum length: 60. |
| `result.data.fields[].profiles[].id` | `string` | Yes | — | Id of the resource. Format: `int64`. |
| `result.data.fields[].view_type` | `object` | Yes | — | View type details of the field |
| `result.data.fields[].view_type.view` | `boolean` | Yes | — | Indicates if the field is viewable |
| `result.data.fields[].view_type.edit` | `boolean` | Yes | — | Indicates if the field is editable |
| `result.data.fields[].view_type.quick_create` | `boolean` | Yes | — | Indicates if the field supports quick create |
| `result.data.fields[].view_type.create` | `boolean` | Yes | — | Indicates if the field supports create |
| `result.data.fields[].separator` | `boolean` | Yes | — | Indicates if the field is a separator |
| `result.data.fields[].searchable` | `boolean` | Yes | — | Indicates if the field is searchable |
| `result.data.fields[].history_tracking_enabled` | `boolean` | Yes | — | Indicates if history tracking is enabled for the field |
| `result.data.fields[].external` | `record` | Yes | — | — |
| `result.data.fields[].api_name` | `string` | Yes | — | API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50. Pattern: `^[A-Za-z][A-Za-z0-9_]*$`. |
| `result.data.fields[].parent_field` | `record` | No | — | — |
| `result.data.fields[].unique` | `object` | Yes | — | Uniqueness details of the field |
| `result.data.fields[].unique.case_sensitive` | `boolean` | No | — | Indicates if the uniqueness is case sensitive |
| `result.data.fields[].enable_colour_code` | `boolean` | Yes | — | Indicates if colour code is enabled for the field |
| `result.data.fields[].child_fields` | `record` | No | — | — |
| `result.data.fields[].pick_list_values` | `record` | Yes | — | — |
| `result.data.fields[].system_mandatory` | `boolean` | Yes | — | Indicates if the field is system mandatory |
| `result.data.fields[].private` | `record` | No | — | — |
| `result.data.fields[].virtual_field` | `boolean` | Yes | — | Indicates if the field is a virtual field |
| `result.data.fields[].json_type` | `string` | No | — | JSON type of the field Maximum length: 25. |
| `result.data.fields[].crypt` | `record` | No | — | — |

The table shows the first 50 fields. Use the live contract 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_fields_get_fields --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.