Picklist Values

Note

To update picklist options, use the PATCH - Custom Field API.

Purpose

To retrieve detailed information about the values in a picklist field, including display value, reference value, colour code, actual value, ID, type, and associated layouts within a specific module in your Zoho CRM account.

Endpoints

GET /settings/fields/{picklist_field_ID}/pick_list_values?module={module_API_name}

Request Details

Request URL

{api-domain}/crm/{version}/settings/fields/{picklist_field_ID}/pick_list_values

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.fields.READ (or)
ZohoCRM.settings.fields.ALL (or)
ZohoCRM.settings.ALL

Parameters

modulestring, mandatory
Specify the module to which the picklist field belongs to.
Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Appointments, and Service.

Sample Request

Copied"https://www.zohoapis.com/crm/v8/settings/fields/2423488000000000573/pick_list_values?module=Leads"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

sequence_numberinteger
Represents the position of the picklist value field in the layout.
display_valuestring
Represents the display value of the picklist option.
reference_valuestring
Represents the reference value of the picklist option.
colour_codestring
Represents the hex color code used for the picklist option.
actual_valuestring
Represents the actual value of the picklist option.
idinteger
Represents the unique ID of the picklist option.
typestring
Represents the type of the picklist option.
Possible values :
- used
- unused
layout_associationsstring
Represents the layout details with which the picklist option is associated.
- api_namestring
  Represents the API name of the lyout.
- namestring
  Represents the name of the layout.
- idinteger
  Represents the unique ID of the layout.

Possible Errors

INVALID_DATAHTTP 400
The ID given seems to be invalid
Resolution: Specify a valid picklist field ID. Use the GET Fields Metadata API to retrieve picklist field IDs.
INVALID_MODULEHTTP 400
The given module seems to be invalid
Resolution: Specify a valid module API name. Use the GET Modules Metadata API to retrieve modules API names.
Suuported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, Custom, Appointments, and Service.
REQUIRED_PARAM_MISSINGHTTP 400
Required parameter is missing
Resolution: Specify a value for the module parameter. Refer to the Parameters section at the beginning of this page.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL.
Specify a valid request method. Refer to the Endpoints section at the beginning of this page.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to retrieve the picklist details. Create a new token with valid scope. Refer to the Scope section.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call.
NO_PERMISSIONHTTP 403
No permission
Resolution: The user does not have permission to view the picklist options associations.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the Parameters section at the beginning of this page.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "pick_list_values": [
        {
            "sequence_number": 1,
            "display_value": "Referral",
            "reference_value": "Referral",
            "colour_code": null,
            "actual_value": "Referral",
            "id": "2423488000000002313",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 2,
            "display_value": "Advertisement",
            "reference_value": "Advertisement",
            "colour_code": null,
            "actual_value": "Advertisement",
            "id": "2423488000000002315",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                }
            ]
        },
        {
            "sequence_number": 3,
            "display_value": "Cold Call",
            "reference_value": "Cold Call",
            "colour_code": null,
            "actual_value": "Cold Call",
            "id": "2423488000000002317",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 4,
            "display_value": "Employee Referral",
            "reference_value": "Employee Referral",
            "colour_code": null,
            "actual_value": "Employee Referral",
            "id": "2423488000000002319",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 5,
            "display_value": "External Referral",
            "reference_value": "External Referral",
            "colour_code": null,
            "actual_value": "External Referral",
            "id": "2423488000000002321",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        {
            "sequence_number": 6,
            "display_value": "Online Store",
            "reference_value": "Online Store",
            "colour_code": null,
            "actual_value": "OnlineStore",
            "id": "2423488000000172095",
            "type": "used",
            "layout_associations": [
                {
                    "api_name": "Standard__s",
                    "name": "Standard",
                    "id": "2423488000000095055"
                },
                {
                    "api_name": "testing_layout",
                    "name": "testing layout",
                    "id": "2423488000000771002"
                }
            ]
        },
        .
        .
        .
        
    ]
}