Get a picklist field option

get a picklist field option

GET/settings/fields/{fieldId}/pick_list_values/{pickListValueId}

Use it in a workflow

Add a step and choose the Zoho CRM connector.
Pick the Get a picklist field option action (under Metadata).
Fill in the fields below, then reference the result from later steps as {{getAPicklistFieldOption.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.

pickListValueIdstring (int64)required

Path parameter: pickListValueId

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 {{getAPicklistFieldOption.response.data.<field>}}.

pick_list_valuesarray<object>

PickList option of the mention picklist unique Id

sequence_numberinteger (int32)required

sort order of the option respective to field

display_valuestringrequired

Display value of the picklist option which are localised or translated

reference_valuestringrequired

Reference value of the picklist option which are localised or updated

colour_codestring | nullrequired

Color code of the picklist option when the picklist field in color code enabled

actual_valuestringrequired

Actual value of the picklist option.

idstring (int64)required

Unique Id of the picklist option

typestringrequired

Presence of the option in layouts and in the module

One ofusedunused

layout_associationsarray | nullrequired

Layout Association of the picklist option

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?