Returns the available pick list values for a specified field in a module. Published by Zoho in its first-party OpenAPI 3.1.0 repository github.com/zoho/crm-oas; 1 operation(s).
{
"openapi": "3.1.0",
"info": {
"title": "Pick List Values",
"description": "Returns the available pick list values for a specified field in a module",
"version": "8.0"
},
"servers": [
{
"url": "https://zohoapis.{dc}/crm/{version}",
"description": "API Server URL",
"variables": {
"dc": {
"enum": [
"com",
"eu",
"in",
"cn",
"au"
],
"default": "com",
"description": "API Server URL TLD"
},
"version": {
"default": "v8",
"description": "API Version"
}
}
}
],
"paths": {
"/settings/fields/{fieldId}/pick_list_values": {
"get": {
"operationId": "getPickListValues",
"summary": "Retrieve pick list values for a field",
"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.",
"parameters": [
{
"$ref": "#/components/parameters/FieldId"
},
{
"$ref": "#/components/parameters/Module"
}
],
"security": [
{
"iam-oauth2-schema": [
"ZohoCRM.settings.fields.READ"
]
}
],
"responses": {
"200": {
"description": "Successfully retrieved pick list values with metadata including sequence, display values (translated if enabled), reference values, color codes, and layout associations.",
"content": {
"application/json": {
"schema": {
"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",
"items": {
"description": "Pick list value object",
"type": "object",
"properties": {
"sequence_number": {
"type": "integer",
"format": "int32",
"description": "Display order sequence for this pick list value",
"minimum": 1
},
"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
},
"maxItems": 2000
}
},
"required": [
"pick_list_values"
],
"additionalProperties": false
}
}
}
},
"204": {
"description": "Field exists in the module but is not a pick list type; no content returned."
},
"400": {
"description": "Bad request due to invalid field_id, invalid module name, or version not supported.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "object",
"description": "Invalid field_id provided in path parameter",
"properties": {
"code": {
"type": "string",
"description": "Error code indicating invalid field_id",
"enum": [
"INVALID_DATA"
]
},
"details": {
"type": "object",
"description": "Additional context about the invalid field_id error",
"properties": {
"resource_path_index": {
"type": "integer",
"format": "int32",
"description": "Zero-based index of the invalid path parameter (2 indicates fieldId position)",
"minimum": 0,
"maximum": 10
}
},
"required": [
"resource_path_index"
],
"additionalProperties": false
},
"message": {
"type": "string",
"description": "Human-readable error message",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "string",
"description": "Response status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"description": "Invalid module name provided in query parameter",
"properties": {
"code": {
"type": "string",
"description": "Error code indicating invalid module name",
"enum": [
"INVALID_MODULE"
]
},
"message": {
"type": "string",
"description": "Human-readable error message",
"minLength": 1,
"maxLength": 255
},
"details": {
"type": "object",
"description": "Additional error context (empty object for this error type)",
"additionalProperties": false
},
"status": {
"type": "string",
"description": "Response status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"message",
"details",
"status"
],
"additionalProperties": false
},
{
"type": "object",
"description": "API version not supported",
"properties": {
"status": {
"type": "string",
"description": "Response status indicator",
"enum": [
"error"
]
},
"code": {
"type": "string",
"description": "Error code indicating unsupported API version",
"enum": [
"VERSION_NOT_SUPPORTED"
]
},
"message": {
"type": "string",
"description": "Human-readable error message about unsupported version",
"minLength": 1,
"maxLength": 255
},
"details": {
"type": "object",
"description": "Additional error context (empty object for this error type)",
"additionalProperties": false
}
},
"required": [
"status",
"code",
"message",
"details"
],
"additionalProperties": false
}
]
}
}
}
},
"403": {
"description": "Insufficient permissions to access field metadata; requires Crm_Implied_Customize_Zoho_CRM permission.",
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Permission denied error response",
"properties": {
"code": {
"type": "string",
"description": "Error code indicating permission denial",
"enum": [
"NO_PERMISSION"
]
},
"details": {
"type": "object",
"description": "Additional context about the permission error",
"properties": {
"permissions": {
"type": "array",
"description": "Required permissions that are missing. Array contains unique permission identifiers; order is not significant.",
"items": {
"type": "string",
"description": "Permission identifier string",
"minLength": 1,
"maxLength": 255
},
"minItems": 1,
"maxItems": 10,
"uniqueItems": true
}
},
"required": [
"permissions"
],
"additionalProperties": false
},
"message": {
"type": "string",
"description": "Human-readable error message describing the permission denial",
"minLength": 1,
"maxLength": 255
},
"status": {
"type": "string",
"description": "Response status indicator",
"enum": [
"error"
]
}
},
"required": [
"code",
"details",
"message",
"status"
],
"additionalProperties": false
}
}
}
}
}
}
}
},
"components": {
"parameters": {
"FieldId": {
"name": "fieldId",
"in": "path",
"required": true,
"description": "Unique numeric identifier for the field. Must be a valid field ID belonging to the specified module.",
"schema": {
"type": "string",
"format": "^[0-9]+$",
"minLength": 1
}
},
"Module": {
"name": "module",
"in": "query",
"required": true,
"description": "API name of the CRM module containing the field. Supports standard modules (e.g., Leads, Contacts, Accounts, Deals) and custom modules. Case-insensitive.",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 50
}
}
},
"securitySchemes": {
"iam-oauth2-schema": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth",
"tokenUrl": "https://accounts.zoho.com/oauth/v2/token",
"refreshUrl": "https://accounts.zoho.com/oauth/v2/token",
"scopes": {
"ZohoCRM.settings.fields.READ": "Read access to CRM fields"
}
}
}
}
}
}
}