Zoho: Get a Single Global Picklist by ID

← Global picklists operations · Get started

Operation zoho.getsingleglobalpicklists

Provider route: GET /crm/v8/settings/global_picklists/{id}. 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["globalPicklists"]["getSingleGlobalPicklists"]>[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.globalPicklists.getSingleGlobalPicklists(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.global_picklists.get_single_global_picklists(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.id	string	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.include	array	Optional	Maximum items: 3
query.include[]	string	Each item	Allowed values for including related resources in the response. One of: used_in_modules, pick_list_values, associated_fields_count
query.include_inner_details	string	Optional	One of: used_in_modules.plural_label
query.fields	array	Optional	Maximum items: 20 Minimum items: 1
query.fields[]	string	Each item	The api_name of a global picklist key to be returned in the response. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$

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	Response object containing an array of global picklists. Additional keys: not allowed
$ (anyOf 1).global_picklists	array	Required within parent	Array of global picklists with their properties. Maximum items: 1
$ (anyOf 1).global_picklists[]	object	Each item	Global picklist object with details. Every key listed here is returned by default. When the ‘fields’ query parameter is used, only the requested keys along with ‘id’ are present in the response, hence ‘id’ is the only key that is always returned. Additional keys: not allowed
$ (anyOf 1).global_picklists[].actual_label	string	Optional	Actual label of the global picklist. Maximum length: 50
$ (anyOf 1).global_picklists[].api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).global_picklists[].associated_fields_count	JSON	Optional
$ (anyOf 1).global_picklists[].associated_fields_count (anyOf 1)	integer	Alternative	Number of fields associated with this global picklist. Format: int32
$ (anyOf 1).global_picklists[].associated_fields_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).global_picklists[].created_by	JSON	Optional	User who created the global picklist.
$ (anyOf 1).global_picklists[].created_by (anyOf 1)	object	Alternative	User object with name and id. Additional keys: not allowed
$ (anyOf 1).global_picklists[].created_by (anyOf 1).id	string	Optional	Id of the resource. Format: int64
$ (anyOf 1).global_picklists[].created_by (anyOf 1).name	string	Optional	Name of the user. Maximum length: 255
$ (anyOf 1).global_picklists[].created_by (anyOf 2)	null	Alternative	Null if no user information is available.
$ (anyOf 1).global_picklists[].created_time	JSON	Optional
$ (anyOf 1).global_picklists[].created_time (anyOf 1)	string	Alternative	Creation timestamp of the global picklist. Format: date-time
$ (anyOf 1).global_picklists[].created_time (anyOf 2)	null	Alternative	Creation timestamp of the global picklist. Format: date-time
$ (anyOf 1).global_picklists[].customizable	boolean	Optional	Indicates if the global picklist is customizable.
$ (anyOf 1).global_picklists[].description	JSON	Optional
$ (anyOf 1).global_picklists[].description (anyOf 1)	string	Alternative	Description of the global picklist. Maximum length: 1000
$ (anyOf 1).global_picklists[].description (anyOf 2)	null	Alternative	Description of the global picklist. Maximum length: 1000
$ (anyOf 1).global_picklists[].display_label	string	Optional	Display label of the global picklist. Maximum length: 50
$ (anyOf 1).global_picklists[].id	string	Required within parent	Id of the resource. Format: int64
$ (anyOf 1).global_picklists[].modified_by	JSON	Optional	User who last modified the global picklist.
$ (anyOf 1).global_picklists[].modified_by (anyOf 1)	object	Alternative	User object with name and id. Additional keys: not allowed
$ (anyOf 1).global_picklists[].modified_by (anyOf 1).id	string	Optional	Id of the resource. Format: int64
$ (anyOf 1).global_picklists[].modified_by (anyOf 1).name	string	Optional	Name of the user. Maximum length: 255
$ (anyOf 1).global_picklists[].modified_by (anyOf 2)	null	Alternative	Null if no user information is available.
$ (anyOf 1).global_picklists[].modified_time	JSON	Optional
$ (anyOf 1).global_picklists[].modified_time (anyOf 1)	string	Alternative	Last modification timestamp of the global picklist. Format: date-time
$ (anyOf 1).global_picklists[].modified_time (anyOf 2)	null	Alternative	Last modification timestamp of the global picklist. Format: date-time
$ (anyOf 1).global_picklists[].pick_list_values	array	Optional	Array of picklist values. Maximum items: 5000
$ (anyOf 1).global_picklists[].pick_list_values[]	Model	Each item	Expand Get All Global Picklists — response body — global picklists global picklists item pick list values item
$ (anyOf 1).global_picklists[].pick_list_values_sorted_lexically	boolean	Optional	Indicates if picklist values are sorted lexically.
$ (anyOf 1).global_picklists[].presence	boolean	Optional	Indicates if the global picklist is present. false if global picklist is in delete scheduler.
$ (anyOf 1).global_picklists[].source	string	Optional	Source of the global picklist. Known values: crm, platform_plugin, marketplace_plugin Maximum length: 50
$ (anyOf 1).global_picklists[].used_in_modules	array	Optional	Array of modules using this global picklist. Maximum items: 100
$ (anyOf 1).global_picklists[].used_in_modules[]	object	Each item	Module object with details. Additional keys: not allowed
$ (anyOf 1).global_picklists[].used_in_modules[].api_name	string	Optional	API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
$ (anyOf 1).global_picklists[].used_in_modules[].id	string	Optional	Id of the resource. Format: int64
$ (anyOf 1).global_picklists[].used_in_modules[].plural_label	string	Optional	Plural label of the module. Maximum length: 25
$ (anyOf 2)	null	Alternative

Referenced models: Get All Global Picklists — response body — global picklists global picklists item pick list values item

Schemas

Get All Global Picklists — response body — global picklists global picklists item pick list values item

Field	Type	Presence	Description and constraints
$	object	Root	Picklist value object. Additional keys: not allowed
actual_value	string	Optional	Actual value of the picklist field. Maximum length: 120
display_value	string	Required within parent	The picklist display value(translated value if translation enabled). Maximum length: 120
id	string	Required within parent	Id of the resource. Format: int64
reference_value	string	Required within parent	Reference value of the picklist field. Maximum length: 120
sequence_number	JSON	Required within parent
sequence_number (anyOf 1)	integer	Alternative	Sequence number of the picklist value. Format: int32
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
type	string	Required within parent	Type of the picklist value (used or unused). Known values: unused, used

Policy, approvals and errors

SDK function policy ID: zoho.getsingleglobalpicklists. Catalog operation: getSingleGlobalPicklists. 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