Zoho CRM Global Picklists

{
  "openapi": "3.1.0",
  "info": {
    "title": "Global Picklists",
    "description": "Global sets are collections of picklist values that can be associated with multiple picklists across modules. Example use cases include maintaining a consistent set of status values or priority levels across different modules in a CRM system. By using global sets, administrators can ensure uniformity and simplify the management of picklist values, as any updates to the global set automatically reflect in all associated picklists. This feature enhances data integrity and reduces redundancy, making it easier to manage and analyze data across various modules.",
    "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": {
          "description": "API Version",
          "default": "v8"
        }
      }
    }
  ],
  "security": [
    {
      "iam-oauth2-schema": [
        "ZohoCRM.settings.global_picklist.ALL",
        "ZohoCRM.settings.ALL",
        "ZohoCRM.settings.global_picklist.READ",
        "ZohoCRM.settings.global_picklist.CREATE",
        "ZohoCRM.settings.global_picklist.UPDATE",
        "ZohoCRM.settings.global_picklist.DELETE"
      ]
    }
  ],
  "paths": {
    "/settings/global_picklists": {
      "get": {
        "summary": "Get all global picklists",
        "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.",
        "operationId": "getBulkGlobalPicklists",
        "parameters": [
          {
            "$ref": "#/components/parameters/Include"
          },
          {
            "$ref": "#/components/parameters/IncludeInnerDetails"
          }
        ],
        "responses": {
          "200": {
            "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.",
            "content": {
              "application/json": {
                "schema": {
                  "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.",
                        "additionalProperties": false,
                        "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": {
                            "$ref": "#/components/schemas/ApiName"
                          },
                          "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": {
                            "$ref": "#/components/schemas/Id"
                          },
                          "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": {
                            "description": "User who last modified the global picklist.",
                            "oneOf": [
                              {
                                "type": "object",
                                "description": "User object with name and id.",
                                "additionalProperties": false,
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the user.",
                                    "maxLength": 255
                                  },
                                  "id": {
                                    "$ref": "#/components/schemas/Id"
                                  }
                                }
                              },
                              {
                                "type": "null",
                                "description": "Null if no user information is available."
                              }
                            ]
                          },
                          "used_in_modules": {
                            "type": [
                              "array",
                              "null"
                            ],
                            "description": "Array of modules using this global picklist.",
                            "maxItems": 100,
                            "items": {
                              "type": "object",
                              "description": "Module object with details.",
                              "additionalProperties": false,
                              "properties": {
                                "plural_label": {
                                  "$ref": "#/components/schemas/ModulepluralLabel"
                                },
                                "api_name": {
                                  "$ref": "#/components/schemas/ApiName"
                                },
                                "id": {
                                  "$ref": "#/components/schemas/Id"
                                }
                              }
                            }
                          },
                          "created_by": {
                            "description": "User who created the global picklist.",
                            "oneOf": [
                              {
                                "type": "object",
                                "description": "User object with name and id.",
                                "additionalProperties": false,
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the user.",
                                    "maxLength": 255
                                  },
                                  "id": {
                                    "$ref": "#/components/schemas/Id"
                                  }
                                }
                              },
                              {
                                "type": "null",
                                "description": "Null if no user information is available."
                              }
                            ]
                          },
                          "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.",
                              "additionalProperties": false,
                              "properties": {
                                "type": {
                                  "type": "string",
                                  "description": "Type of the picklist value (used or unused).",
                                  "enum": [
                                    "unused",
                                    "used"
                                  ]
                                },
                                "id": {
                                  "$ref": "#/components/schemas/Id"
                                },
                                "sequence_number": {
                                  "type": "integer",
                                  "description": "Sequence number of the picklist value.",
                                  "format": "int32"
                                },
                                "display_value": {
                                  "$ref": "#/components/schemas/PickListDisplayValue"
                                },
                                "reference_value": {
                                  "$ref": "#/components/schemas/PickListReferenceValue"
                                },
                                "actual_value": {
                                  "$ref": "#/components/schemas/PickListActualValue"
                                }
                              },
                              "required": [
                                "id",
                                "sequence_number",
                                "type",
                                "display_value",
                                "reference_value"
                              ]
                            }
                          }
                        },
                        "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"
                        ]
                      }
                    }
                  },
                  "required": [
                    "global_picklists"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "204": {
            "description": "No global picklists available. (No content)"
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.settings.global_picklist.READ"
            ]
          }
        ]
      },
      "post": {
        "summary": "Create a new global picklist",
        "description": "Creates a new global picklist with the specified display label, API name, description, and picklist values. The actual_label, customizable, modified_by, created_by, and presence properties are generated by the backend. In pick_list_values, only display_value and type are considered.",
        "operationId": "createGlobalPicklist",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "description": "Request body for creating a new global picklist.",
                "properties": {
                  "global_picklists": {
                    "type": "array",
                    "description": "Array containing the global picklist to create.",
                    "maxItems": 1,
                    "items": {
                      "type": "object",
                      "description": "Global picklist object with creation details.",
                      "properties": {
                        "display_label": {
                          "type": "string",
                          "description": "Display label of the global picklist.",
                          "maxLength": 50
                        },
                        "api_name": {
                          "$ref": "#/components/schemas/ApiName"
                        },
                        "description": {
                          "type": [
                            "string",
                            "null"
                          ],
                          "description": "Description of the global picklist.",
                          "maxLength": 1000
                        },
                        "pick_list_values_sorted_lexically": {
                          "type": "boolean",
                          "description": "Indicates if picklist values should be sorted lexically."
                        },
                        "pick_list_values": {
                          "type": "array",
                          "description": "Array of picklist values. Only display_value and type are considered.",
                          "maxItems": 5000,
                          "items": {
                            "type": "object",
                            "description": "Picklist value object for creation.",
                            "properties": {
                              "display_value": {
                                "$ref": "#/components/schemas/PickListDisplayValue"
                              },
                              "type": {
                                "type": "string",
                                "description": "Type of the picklist value (used or unused).",
                                "enum": [
                                  "unused",
                                  "used"
                                ]
                              }
                            },
                            "required": [
                              "display_value",
                              "type"
                            ],
                            "additionalProperties": true
                          }
                        }
                      },
                      "required": [
                        "display_label",
                        "pick_list_values"
                      ],
                      "additionalProperties": true
                    }
                  }
                },
                "required": [
                  "global_picklists"
                ],
                "additionalProperties": false
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "Created — Global picklist created successfully.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Response object for successful creation of a global picklist.",
                  "properties": {
                    "global_picklists": {
                      "type": "array",
                      "description": "Array containing the created global picklist response.",
                      "maxItems": 1,
                      "items": {
                        "type": "object",
                        "description": "Created global picklist response details.",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Response code indicating successful creation.",
                            "enum": [
                              "SUCCESS"
                            ]
                          },
                          "details": {
                            "type": "object",
                            "description": "Details of the created global picklist.",
                            "properties": {
                              "id": {
                                "$ref": "#/components/schemas/Id"
                              }
                            },
                            "required": [
                              "id"
                            ],
                            "additionalProperties": false
                          },
                          "message": {
                            "type": "string",
                            "description": "Human-readable success message.",
                            "maxLength": 255
                          },
                          "status": {
                            "type": "string",
                            "description": "Status of the operation.",
                            "enum": [
                              "success"
                            ]
                          }
                        },
                        "required": [
                          "code",
                          "details",
                          "message",
                          "status"
                        ],
                        "additionalProperties": false
                      }
                    }
                  },
                  "required": [
                    "global_picklists"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "400": {
            "description": "Bad Request — Invalid data, missing required fields, duplicate values, special characters, length exceeded, limit exceeded, or reserved keywords.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "description": "Error response object for bad request containing global picklist creation errors.",
                  "properties": {
                    "global_picklists": {
                      "type": "array",
                      "description": "Array of global picklist creation error details.",
                      "maxItems": 1,
                      "items": {
                        "type": "object",
                        "description": "Global picklist creation error object.",
                        "properties": {
                          "code": {
                            "type": "string",
                            "description": "Error code indicating the type of validation or constraint failure.",
                            "enum": [
                              "INVALID_DATA",
                              "DUPLICATE_DATA",
                              "MANDATORY_NOT_FOUND",
                              "LIMIT_EXCEEDED",
                              "NOT_ALLOWED"
                            ]
                          },
                          "details": {
                            "type": "object",
                            "description": "Additional error-specific details.",
                            "properties": {
                              "api_name": {
                                "type": "string",
                                "description": "Name of the field causing the error.",
                                "maxLength": 100
                              },
                              "json_path": {
                                "type": "string",
                                "description": "JSON path to the field causing the error.",
                                "maxLength": 255
                              },
                              "maximum_length": {
                                "type": "integer",
                                "description": "Maximum allowed length for the global field label, description, or picklist value.",
                                "format": "int32"
                              },
                              "regex": {
                                "type": "string",
                                "description": "Expected regex pattern for the field value.",
                                "maxLength": 100
                              },
                              "limit_due_to": {
                                "type": "array",
                                "description": "List of fields that caused the limit to be exceeded.",
                                "maxItems": 10,
                                "items": {
                                  "type": "object",
                                  "description": "Field causing limit exceeded error.",
                                  "properties": {
                                    "api_name": {
                                      "type": "string",
                                      "description": "API name of the field causing limit issue.",
                                      "maxLength": 100
                                    },
                                    "json_path": {
                                      "type": "string",
                                      "description": "JSON path to the field causing limit issue.",
                                      "maxLength": 255
                                    }
                                  },
                                  "required": [
                                    "api_name",
                                    "json_path"
                                  ],
                                  "additionalProperties": false
                                }
                              },
                              "limit": {
                                "type": "integer",
                                "description": "The maximum allowed limit that has been exceeded.",
                                "format": "int32"
                              }
                            },
                            "additionalProperties": false
                          },
                          "message": {
                            "type": "string",
                            "description": "Human-readable message describing the error.",
                            "maxLength": 255
                          },
                          "status": {
                            "type": "string",
                            "description": "Status of the error response.",
                            "enum": [
                              "error"
                            ]
                          }
                        },
                        "required": [
                          "code",
                          "details",
                          "message",
                          "status"
                        ],
                        "additionalProperties": false
                      }
                    }
                  },
                  "required": [
                    "global_picklists"
                  ],
                  "additionalProperties": false
                }
              }
            }
          },
          "403": {
            "$ref": "#/components/responses/Forbidden"
          },
          "500": {
            "$ref": "#/components/responses/InternalServerError"
          }
        },
        "security": [
          {
            "iam-oauth2-schema": [
              "ZohoCRM.settings.global_picklist.CREATE"
            ]
          }
        ]
      }
    },
    "/settings/global_picklists/{id}": {
      "get": {
        "summary": "Get a single global picklist by id",
        "description": "Fetches the global picklist for given id along with their 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.",
        "operationId": "getSingleGlobalPicklists",
        "parameters": [
          {
            "$ref": "#/components/parameters/Id"
          },
          {
            "$ref": "#/components/parameters/Include"
          },
          {
            "$ref": "#/components/parameters/IncludeInnerDetails"
          }
        ],
        "responses": {
          "200": {
            "description": "Fetches the global picklist for given id along with their 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.",
            "content": {
              "application/json": {
                "schema": {
                  "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": 1,
                      "items": {
                        "type": "object",
                        "description": "Global picklist object with details.",
                        "additionalProperties": false,
                        "properties": {
                          "display_label": {
                            "type": "string",
                            "description": "Display label of the global picklist.",
                            "maxLength": 50
                          },
                          "api_name": {
                            "$ref": "#/components/schemas/ApiName"
                          },
                          "source": {
                            "type": "string",
                            "description": "Source of the global picklist.",
                            "maxLength": 50,
                            "enum": [
                              "crm",
                              "platform_plugin",
                              "marketplace_plugin"
                            ]
                          },
                          "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": {
                            "$ref": "#/components/schemas/Id"
                          },
                          "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": {
                            "description": "User who last modified the global picklist.",
                            "oneOf": [
                              {
                                "type": "object",
                                "description": "User object with name and id.",
                                "additionalProperties": false,
                                "properties": {
                                  "name": {
                                    "type": "string",
                                    "description": "Name of the user.",
                                    "maxLength": 255
                                  },
                                  "id": {
                                    "$ref": "#/components/schemas/Id"
                                  }
                                }
                              },
                              {
                                "type": "null",
                                "description": "Null if no user information is available."
                              }
                            ]
                          },
                          "used_in_modules": {
                            "type": "array",
                            "description": "Array of modules using this global picklist.",
                            "maxItems": 100,
                            "items": {
                              "type": "object",
                              "description": "Module object with details.",
                              "additionalProperties": false,
                              "properties": {
                                "plural_label": {
                                  "$ref": "#/components/schemas/ModulepluralLabel"
                                },
                                "api_name": {
                                  "$ref": "#/components/schemas/ApiName"
                                },
                                "id": {
                                  "$ref": "#/components/schemas/Id"
                                }
                              }
                            }
                          },
                          "created_by": {
                            "description": "User w

# --- truncated at 32 KB (121 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho-crm/refs/heads/main/openapi/zoho-crm-global-picklists-openapi.json