> ## 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: Pick List Values Get Pick List Values

> List the picklist values of a Zoho CRM field, with display labels and layouts. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

List the picklist values of a Zoho CRM field, with display labels and layouts.

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

## 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_pick_list_values_get_pick_list_values',
  {
    "fieldId": "field_123",
    "module": "example"
  },
);

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

### CLI

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

## Example response

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

## Input reference

Returns the available pick list values for a specified field in a module, including display values (with translations if enabled), reference values, layout associations, and metadata. Returns 204 if the field exists but is not a pick list type. Does not support pagination.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.fieldId` | `string` | Yes | — | Unique numeric identifier for the field. Must be a valid field ID belonging to the specified module. Format: `^[0-9]+$`. Minimum length: 1. |
| `payload.module` | `string` | Yes | — | API name of the CRM module containing the field. Supports standard modules (e.g., Leads, Contacts, Accounts, Deals) and custom modules. Case-insensitive. Minimum length: 1. Maximum length: 50. |

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns the available pick list values for a specified field in a module, including display values (with translations if enabled), reference values, layout associations, and metadata. Returns 204 if the field exists but is not a pick list type. Does not support pagination.",
    "properties": {
      "fieldId": {
        "type": "string",
        "description": "Unique numeric identifier for the field. Must be a valid field ID belonging to the specified module.",
        "minLength": 1,
        "format": "^[0-9]+$"
      },
      "module": {
        "type": "string",
        "description": "API name of the CRM module containing the field. Supports standard modules (e.g., Leads, Contacts, Accounts, Deals) and custom modules. Case-insensitive.",
        "minLength": 1,
        "maxLength": 50
      }
    },
    "required": [
      "fieldId",
      "module"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response schema for pick list values with metadata |
| `result.data.pick_list_values` | `array` | Yes | — | Array of pick list value objects with metadata Maximum items: 2000. |
| `result.data.pick_list_values[].sequence_number` | `integer` | Yes | — | Display order sequence for this pick list value Format: `int32`. Minimum: 1. |
| `result.data.pick_list_values[].display_value` | `string` | Yes | — | Translated value displayed to users (same as reference\_value if translation not enabled) Maximum length: 120. |
| `result.data.pick_list_values[].reference_value` | `string` | Yes | — | Untranslated reference value used for API operations Maximum length: 120. |
| `result.data.pick_list_values[].colour_code` | `string \| null` | Yes | — | Hexadecimal color code for UI rendering. Null if no color assigned. Pattern: `^#[0-9a-fA-F]&#123;6&#125;$`. |
| `result.data.pick_list_values[].actual_value` | `string` | Yes | — | Internal value used for system operations Maximum length: 120. |
| `result.data.pick_list_values[].id` | `string` | Yes | — | Unique identifier for this pick list value Format: `^[0-9]+$`. |
| `result.data.pick_list_values[].type` | `"used" \| "unused"` | Yes | — | Usage status of the pick list value Allowed: `used`, `unused`. |
| `result.data.pick_list_values[].layout_associations` | `array \| null` | Yes | — | Layouts where this pick list value is available. Null if the value is unused or not associated with any layout. Layout IDs are unique within this array. |
| `result.data.pick_list_values[].layout_associations[].api_name` | `string` | Yes | — | API name of the associated layout Maximum length: 50. |
| `result.data.pick_list_values[].layout_associations[].name` | `string` | Yes | — | Display name of the associated layout Maximum length: 50. |
| `result.data.pick_list_values[].layout_associations[].id` | `string` | Yes | — | Unique identifier of the associated layout Format: `^[0-9]+$`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

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

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response schema for pick list values with metadata",
        "properties": {
          "pick_list_values": {
            "type": "array",
            "description": "Array of pick list value objects with metadata",
            "maxItems": 2000,
            "items": {
              "type": "object",
              "description": "Pick list value object",
              "properties": {
                "sequence_number": {
                  "type": "integer",
                  "description": "Display order sequence for this pick list value",
                  "minimum": 1,
                  "format": "int32"
                },
                "display_value": {
                  "type": "string",
                  "description": "Translated value displayed to users (same as reference_value if translation not enabled)",
                  "maxLength": 120
                },
                "reference_value": {
                  "type": "string",
                  "description": "Untranslated reference value used for API operations",
                  "maxLength": 120
                },
                "colour_code": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Hexadecimal color code for UI rendering. Null if no color assigned.",
                  "pattern": "^#[0-9a-fA-F]{6}$"
                },
                "actual_value": {
                  "type": "string",
                  "description": "Internal value used for system operations",
                  "maxLength": 120
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier for this pick list value",
                  "format": "^[0-9]+$"
                },
                "type": {
                  "type": "string",
                  "description": "Usage status of the pick list value",
                  "enum": [
                    "used",
                    "unused"
                  ]
                },
                "layout_associations": {
                  "type": [
                    "array",
                    "null"
                  ],
                  "description": "Layouts where this pick list value is available. Null if the value is unused or not associated with any layout. Layout IDs are unique within this array.",
                  "items": {
                    "type": "object",
                    "description": "Layout association object",
                    "properties": {
                      "api_name": {
                        "type": "string",
                        "description": "API name of the associated layout",
                        "maxLength": 50
                      },
                      "name": {
                        "type": "string",
                        "description": "Display name of the associated layout",
                        "maxLength": 50
                      },
                      "id": {
                        "type": "string",
                        "description": "Unique identifier of the associated layout",
                        "format": "^[0-9]+$"
                      }
                    },
                    "required": [
                      "api_name",
                      "name",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                }
              },
              "required": [
                "sequence_number",
                "display_value",
                "reference_value",
                "colour_code",
                "actual_value",
                "id",
                "type",
                "layout_associations"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "pick_list_values"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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.