Picklist Values for a Field

GET/settings/fields/{fieldId}/pick_list_values

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Picklist Values for a Field action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{picklistValuesForAField.response.data}}.

Request

Path parameters

fieldIdstring (int64)required

Specify the unique numeric identifier of the field. Refer to the [Get Fields Metadata](fields.json#$.paths./settings/fields/{fieldId}.get) resource for valid values.

Query parameters

modulestringrequired

Specify the API name of the CRM module that contains the field. Refer to the [Get Modules](modules.json#$.paths./settings/modules.get) resource for valid values.

Response

Returns 200 with an object. Read it in later steps with {{picklistValuesForAField.response.data.<field>}}.

pick_list_valuesarray<object>

Represents the list of picklist value objects retrieved for the specified field.

sequence_numberinteger (int32)required

Represents the display order position of the picklist value in the list.

display_valuestringrequired

Represents the translated display value of the picklist option shown to users. When translation is not enabled, this value matches **reference_value**.

reference_valuestringrequired

Represents the untranslated reference value of the picklist option used in API operations.

colour_codestring | nullrequired

Hexadecimal color code for UI rendering. Null if no color assigned.

actual_valuestringrequired

Represents the actual internal value of the picklist option stored in the system.

idstring (int64)required

Represents the unique identifier of this pick list value

typestringrequired

Represents the usage status of the picklist value in the CRM field. Possible values: **used** - The picklist value is active and available for selection. **unused** - The picklist value is inactive and not available for selection. Always returned in the response.

One ofusedunused

layout_associationsarray | nullrequired

Represents the layouts with which this picklist value is associated. Returns **null** if the value is unused or not associated with any layout. Always returned in the response. Refer to the [Get Layouts](layouts.json#$.paths./settings/layouts.get) endpoint for details. Layout IDs are unique within this array.

json

{
  "pick_list_values": [
    {
      "sequence_number": 0,
      "display_value": "string",
      "reference_value": "string",
      "colour_code": "string",
      "actual_value": "string",
      "id": "string",
      "type": "used",
      "layout_associations": null
    }
  ]
}

Need more? See the Zoho CRM guide for connection setup and behaviour shared by every action.

Was this page helpful?