> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> Get all global picklists. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.
Get all global picklists.
Tool ID: `zoho_crm_global_picklists_get_bulk_global_picklists`
## Run this action
Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.
```ts theme={null}
import { Deepline } from 'deepline';
const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
'zoho_crm_global_picklists_get_bulk_global_picklists',
{
"include": [
"used_in_modules"
],
"include_inner_details": "used_in_modules.plural_label"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_global_picklists_get_bulk_global_picklists --input '{
"include": [
"used_in_modules"
],
"include_inner_details": "used_in_modules.plural_label"
}' --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_global_picklists_get_bulk_global_picklists --json` for the complete live contract.
## Input reference
Fetches the list of global picklists available in the organization along with their details. pick\_list\_values, used\_in\_modules, and associated\_fields\_count can be included in the response based on the 'include' query parameter. A 204 is returned when no global picklists exist.
| Name | Type | Required | Default | Details |
| ------------------------------- | -------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `payload.include` | `array` | No | — | Comma-separated list of related resources to include. Allowed values: "used\_in\_modules", "pick\_list\_values", "associated\_fields\_count". Use CSV encoding (style=form, explode=false) for multiple values, e.g. include=used\_in\_modules,pick\_list\_values. Maximum items: 3. |
| `payload.include_inner_details` | `"used_in_modules.plural_label"` | No | — | Optional detailed expansion keys. Currently only allowed when `used_in_modules` is present in `include`. Allowed value: used\_in\_modules.plural\_label. Allowed: `used_in_modules.plural_label`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Fetches the list of global picklists available in the organization along with their details. pick_list_values, used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. A 204 is returned when no global picklists exist.",
"properties": {
"include": {
"type": "array",
"description": "Comma-separated list of related resources to include. Allowed values: \"used_in_modules\", \"pick_list_values\", \"associated_fields_count\". Use CSV encoding (style=form, explode=false) for multiple values, e.g. include=used_in_modules,pick_list_values.",
"maxItems": 3,
"items": {
"type": "string",
"description": "Allowed values for including related resources in the response.",
"enum": [
"used_in_modules",
"pick_list_values",
"associated_fields_count"
]
}
},
"include_inner_details": {
"type": "string",
"description": "Optional detailed expansion keys. Currently only allowed when `used_in_modules` is present in `include`. Allowed value: used_in_modules.plural_label.",
"enum": [
"used_in_modules.plural_label"
]
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ------------------------------------------------------------------- | ---------------------------------------------------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Response object containing an array of global picklists. |
| `result.data.global_picklists` | `array` | Yes | — | Array of global picklists with their properties. Maximum items: 100. |
| `result.data.global_picklists[].display_label` | `string` | Yes | — | Display label of the global picklist. Maximum length: 50. |
| `result.data.global_picklists[].source` | `"crm" \| "platform_plugin" \| "marketplace_plugin"` | Yes | — | Source of the global picklist. Allowed: `crm`, `platform_plugin`, `marketplace_plugin`. Maximum length: 50. |
| `result.data.global_picklists[].api_name` | `string` | Yes | — | 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_]*$`. |
| `result.data.global_picklists[].created_time` | `string \| null` | Yes | — | Creation timestamp of the global picklist. Format: `date-time`. |
| `result.data.global_picklists[].modified_time` | `string \| null` | Yes | — | Last modification timestamp of the global picklist. Format: `date-time`. |
| `result.data.global_picklists[].id` | `string` | Yes | — | Id of the resource. Format: `int64`. |
| `result.data.global_picklists[].actual_label` | `string` | Yes | — | Actual label of the global picklist. Maximum length: 50. |
| `result.data.global_picklists[].description` | `string \| null` | Yes | — | Description of the global picklist. Maximum length: 1000. |
| `result.data.global_picklists[].associated_fields_count` | `integer` | No | — | Number of fields associated with this global picklist. Format: `int32`. |
| `result.data.global_picklists[].modified_by` | `record` | Yes | — | User who last modified the global picklist. |
| `result.data.global_picklists[].used_in_modules` | `array \| null` | No | — | Array of modules using this global picklist. Maximum items: 100. |
| `result.data.global_picklists[].used_in_modules[].plural_label` | `string` | No | — | Plural label of the module. Maximum length: 25. |
| `result.data.global_picklists[].used_in_modules[].api_name` | `string` | No | — | 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_]*$`. |
| `result.data.global_picklists[].used_in_modules[].id` | `string` | No | — | Id of the resource. Format: `int64`. |
| `result.data.global_picklists[].created_by` | `record` | Yes | — | User who created the global picklist. |
| `result.data.global_picklists[].presence` | `boolean` | Yes | — | Indicates if the global picklist is present. false if global picklist is in delete scheduler. |
| `result.data.global_picklists[].customizable` | `boolean` | Yes | — | Indicates if the global picklist is customizable. |
| `result.data.global_picklists[].pick_list_values_sorted_lexically` | `boolean` | Yes | — | Indicates if picklist values are sorted lexically. |
| `result.data.global_picklists[].pick_list_values` | `array` | No | — | Array of picklist values. Maximum items: 5000. |
| `result.data.global_picklists[].pick_list_values[].type` | `"unused" \| "used"` | Yes | — | Type of the picklist value (used or unused). Allowed: `unused`, `used`. |
| `result.data.global_picklists[].pick_list_values[].id` | `string` | Yes | — | Id of the resource. Format: `int64`. |
| `result.data.global_picklists[].pick_list_values[].sequence_number` | `integer` | Yes | — | Sequence number of the picklist value. Format: `int32`. |
| `result.data.global_picklists[].pick_list_values[].display_value` | `string` | Yes | — | The picklist display value(translated value if translation enabled). Maximum length: 120. |
| `result.data.global_picklists[].pick_list_values[].reference_value` | `string` | Yes | — | Reference value of the picklist field. Maximum length: 120. |
| `result.data.global_picklists[].pick_list_values[].actual_value` | `string` | No | — | Actual value of the picklist field. Maximum length: 120. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Response object containing an array of global picklists.",
"properties": {
"global_picklists": {
"type": "array",
"description": "Array of global picklists with their properties.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Global picklist object with details.",
"properties": {
"display_label": {
"type": "string",
"description": "Display label of the global picklist.",
"maxLength": 50
},
"source": {
"type": "string",
"description": "Source of the global picklist.",
"maxLength": 50,
"enum": [
"crm",
"platform_plugin",
"marketplace_plugin"
]
},
"api_name": {
"type": "string",
"description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.",
"maxLength": 50,
"pattern": "^[A-Za-z][A-Za-z0-9_]*$"
},
"created_time": {
"type": [
"string",
"null"
],
"description": "Creation timestamp of the global picklist.",
"format": "date-time"
},
"modified_time": {
"type": [
"string",
"null"
],
"description": "Last modification timestamp of the global picklist.",
"format": "date-time"
},
"id": {
"type": "string",
"description": "Id of the resource.",
"format": "int64"
},
"actual_label": {
"type": "string",
"description": "Actual label of the global picklist.",
"maxLength": 50
},
"description": {
"type": [
"string",
"null"
],
"description": "Description of the global picklist.",
"maxLength": 1000
},
"associated_fields_count": {
"type": "integer",
"description": "Number of fields associated with this global picklist.",
"format": "int32"
},
"modified_by": {
"type": "object",
"description": "User who last modified the global picklist.",
"additionalProperties": true
},
"used_in_modules": {
"type": [
"array",
"null"
],
"description": "Array of modules using this global picklist.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Module object with details.",
"properties": {
"plural_label": {
"type": "string",
"description": "Plural label of the module.",
"maxLength": 25
},
"api_name": {
"type": "string",
"description": "API name of the resource. It will start with alphabets and can contain alphanumeric characters and underscores.",
"maxLength": 50,
"pattern": "^[A-Za-z][A-Za-z0-9_]*$"
},
"id": {
"type": "string",
"description": "Id of the resource.",
"format": "int64"
}
},
"additionalProperties": false
}
},
"created_by": {
"type": "object",
"description": "User who created the global picklist.",
"additionalProperties": true
},
"presence": {
"type": "boolean",
"description": "Indicates if the global picklist is present. false if global picklist is in delete scheduler."
},
"customizable": {
"type": "boolean",
"description": "Indicates if the global picklist is customizable."
},
"pick_list_values_sorted_lexically": {
"type": "boolean",
"description": "Indicates if picklist values are sorted lexically."
},
"pick_list_values": {
"type": "array",
"description": "Array of picklist values.",
"maxItems": 5000,
"items": {
"type": "object",
"description": "Picklist value object.",
"properties": {
"type": {
"type": "string",
"description": "Type of the picklist value (used or unused).",
"enum": [
"unused",
"used"
]
},
"id": {
"type": "string",
"description": "Id of the resource.",
"format": "int64"
},
"sequence_number": {
"type": "integer",
"description": "Sequence number of the picklist value.",
"format": "int32"
},
"display_value": {
"type": "string",
"description": "The picklist display value(translated value if translation enabled).",
"maxLength": 120
},
"reference_value": {
"type": "string",
"description": "Reference value of the picklist field.",
"maxLength": 120
},
"actual_value": {
"type": "string",
"description": "Actual value of the picklist field.",
"maxLength": 120
}
},
"required": [
"id",
"sequence_number",
"type",
"display_value",
"reference_value"
],
"additionalProperties": false
}
}
},
"required": [
"display_label",
"api_name",
"description",
"customizable",
"pick_list_values_sorted_lexically",
"modified_time",
"modified_by",
"id",
"source",
"actual_label",
"created_time",
"created_by",
"presence"
],
"additionalProperties": false
}
}
},
"required": [
"global_picklists"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)