Zoho: Picklist Values for a Field

← Pick list values operations · Get started

Operation zoho.getpicklistvalues

Provider route: GET /crm/v8/settings/fields/{fieldId}/pick_list_values. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["pickListValues"]["getPickListValues"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.pickListValues.getPickListValues(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.pick_list_values.get_pick_list_values(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.fieldId	string	Required within parent	Format: int64 Minimum length: 1
query	object	Required within parent	Additional keys: not allowed
query.module	string	Required within parent	Maximum length: 50 Minimum length: 1

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Contains the picklist values with metadata for the specified field, including display names, reference values, color codes, usage status, and layout associations. Additional keys: not allowed
$ (anyOf 1).pick_list_values	array	Required within parent	Represents the list of picklist value objects retrieved for the specified field. Maximum items: 2000
$ (anyOf 1).pick_list_values[]	object	Each item	Pick list value object Additional keys: not allowed
$ (anyOf 1).pick_list_values[].actual_value	string	Required within parent	Represents the actual internal value of the picklist option stored in the system. Maximum length: 120
$ (anyOf 1).pick_list_values[].colour_code	JSON	Required within parent
$ (anyOf 1).pick_list_values[].colour_code (anyOf 1)	string	Alternative	Hexadecimal color code for UI rendering. Null if no color assigned. Maximum length: 9 Pattern: ^#[0-9a-fA-F]{6}$
$ (anyOf 1).pick_list_values[].colour_code (anyOf 2)	null	Alternative	Hexadecimal color code for UI rendering. Null if no color assigned. Maximum length: 9 Pattern: ^#[0-9a-fA-F]{6}$
$ (anyOf 1).pick_list_values[].display_value	string	Required within parent	Represents the translated display value of the picklist option shown to users. When translation is not enabled, this value matches reference_value. Maximum length: 120
$ (anyOf 1).pick_list_values[].id	string	Required within parent	Represents the unique identifier of this pick list value Format: int64
$ (anyOf 1).pick_list_values[].layout_associations	JSON	Required within parent
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 1)	array	Alternative	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. Maximum items: 10
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 1)[]	object	Each item	Layout association object Additional keys: not allowed
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 1)[].api_name	string	Required within parent	Represents the API name of the associated layout. Maximum length: 50
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 1)[].id	string	Required within parent	Unique identifier of the associated layout Format: int64
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 1)[].name	string	Required within parent	Display name of the associated layout Maximum length: 40
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 2)	null	Alternative	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. Maximum items: 10
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 2)[]	object	Each item	Layout association object Additional keys: not allowed
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 2)[].api_name	string	Required within parent	Represents the API name of the associated layout. Maximum length: 50
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 2)[].id	string	Required within parent	Unique identifier of the associated layout Format: int64
$ (anyOf 1).pick_list_values[].layout_associations (anyOf 2)[].name	string	Required within parent	Display name of the associated layout Maximum length: 40
$ (anyOf 1).pick_list_values[].reference_value	string	Required within parent	Represents the untranslated reference value of the picklist option used in API operations. Maximum length: 120
$ (anyOf 1).pick_list_values[].sequence_number	JSON	Required within parent
$ (anyOf 1).pick_list_values[].sequence_number (anyOf 1)	integer	Alternative	Represents the display order position of the picklist value in the list. Format: int32 Minimum: 1
$ (anyOf 1).pick_list_values[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).pick_list_values[].type	string	Required within parent	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. Known values: used, unused
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getpicklistvalues. Catalog operation: getPickListValues. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source