Zoho · Schema
CoqlFieldSchema
Schema representing a field in the module.
AnalyticsCollaborationCRMCustomer ServiceEmailFinanceHuman ResourcesProject ManagementZoho
Properties
| Name | Type | Description |
|---|---|---|
| associated_module | object | |
| webhook | boolean | Wether webhook is enabled for the field |
| operation_type | object | Operation types allowed for the field |
| colour_code_enabled_by_system | boolean | Wether any colour code is enabled by system |
| field_label | string | Plural label of the module. |
| tooltip | object | |
| display_format_properties | object | |
| type | string | Type of the field used or unused. |
| field_read_only | boolean | Wether field is read only |
| customizable_properties | object | |
| display_label | string | Display label of the field. |
| read_only | boolean | Wether field is read only |
| association_details | object | |
| multi_module_lookup | object | |
| id | object | |
| created_time | object | |
| filterable | boolean | Indicates if the field is filterable |
| visible | boolean | Indicates if the field is visible |
| view_type | object | View type details of the field |
| separator | boolean | Indicates if the field is a separator |
| searchable | boolean | Indicates if the field is searchable |
| history_tracking_enabled | boolean | Indicates if history tracking is enabled for the field |
| external | object | |
| api_name | object | |
| parent_field | object | |
| unique | object | Uniqueness details of the field |
| enable_colour_code | boolean | Indicates if colour code is enabled for the field |
| child_fields | object | |
| pick_list_values | object | |
| system_mandatory | boolean | Indicates if the field is system mandatory |
| private | object | |
| virtual_field | boolean | Indicates if the field is a virtual field |
| json_type | string | JSON type of the field |
| crypt | object | |
| range | object | |
| created_source | string | The source from which the field was created |
| display_type | number | The display type of the field |
| ui_type | number | The UI type of the field |
| modified_time | object | |
| public | boolean | Indicates if the field is public |
| email_parser | object | Email parser details of the field |
| currency | object | |
| custom_field | boolean | Indicates if the field is a custom field |
| lookup | object | |
| hipaa_compliance | object | |
| convert_mapping | object | Convert mapping details of the field |
| address | object | |
| rollup_summary | object | |
| length | number | The length of the field |
| column_name | string | The column name of the field |
| display_field | boolean | Indicates if the field is a display field |
| pick_list_values_sorted_lexically | boolean | Indicates if the pick list values are sorted lexically |
| sortable | boolean | Indicates if the field is sortable |
| global_picklist | object | |
| display_format | object | |
| history_tracking | object | |
| data_type | string | The data type of the field |
| formula | object | |
| additional_column | object | |
| decimal_place | object | |
| multiselectlookup | object | |
| auto_number | object | |
| layout_associations | array | List of layout associations for the field |
| quick_sequence_number | string | The quick sequence number of the field |
| blueprint_supported | boolean | Indicates if the field supports blueprint |
| textarea | object | Textarea field details |
| sharing_properties | object | Sharing properties of the field |
| multiuserlookup | object | Multi-user lookup details of the field |
| table_name | string | The table name which stores this field |
| required | boolean | Indicates if the field is required |
| refer_from_field | object | |
| default_value | True | |
| lucene_colname | string | The Lucene column name of the field |
| generated_type | integer | The created source |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/zoho/main/json-schema/zoho-coql-field-schema-schema.json",
"title": "CoqlFieldSchema",
"description": "Schema representing a field in the module.",
"x-generated": "2026-10-04",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/zoho-coql-api-openapi.yml#/components/schemas/CoqlFieldSchema",
"type": "object",
"properties": {
"associated_module": {
"oneOf": [
{
"type": "object",
"description": "Gives detail related to the associated module LIKE subform",
"properties": {
"module": {
"$ref": "#/$defs/ModuleName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"module",
"id"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"webhook": {
"type": "boolean",
"description": "Wether webhook is enabled for the field"
},
"operation_type": {
"type": "object",
"additionalProperties": false,
"description": "Operation types allowed for the field",
"properties": {
"web_update": {
"type": "boolean",
"description": "Wether any operation is allowed through web update"
},
"api_create": {
"type": "boolean",
"description": "Wether any operation is allowed through API create"
},
"web_create": {
"type": "boolean",
"description": "Wether any operation is allowed through web create"
},
"api_update": {
"type": "boolean",
"description": "Wether any operation is allowed through API update"
}
},
"required": [
"web_update",
"api_create",
"web_create",
"api_update"
]
},
"colour_code_enabled_by_system": {
"type": "boolean",
"description": "Wether any colour code is enabled by system"
},
"field_label": {
"type": "string",
"description": "Plural label of the module.",
"maxLength": 50
},
"tooltip": {
"oneOf": [
{
"type": "object",
"description": "if tool tip is enabled then it will return the information",
"properties": {
"name": {
"type": "string",
"description": "it gives the name of the tool tip",
"maxLength": 25
},
"value": {
"type": "string",
"description": "Text for the tool tip",
"maxLength": 255
}
},
"required": [
"name",
"value"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"display_format_properties": {
"oneOf": [
{
"type": "object",
"description": "if display format properties is available then it will return the information",
"properties": {
"split": {
"type": "number",
"description": "for phone it will return the split value",
"format": "int32"
},
"radio_display_type": {
"type": "string",
"description": "for radiobutton it will return the display type",
"maxLength": 25
}
},
"required": [],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"type": {
"type": "string",
"description": "Type of the field used or unused.",
"maxLength": 25
},
"field_read_only": {
"type": "boolean",
"description": "Wether field is read only"
},
"customizable_properties": {
"oneOf": [
{
"type": "array",
"description": "Customizable properties of the field",
"items": {
"type": "string",
"description": "A customizable property of the field",
"maxLength": 50
},
"maxItems": 100
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"display_label": {
"type": "string",
"description": "Display label of the field.",
"maxLength": 50
},
"read_only": {
"type": "boolean",
"description": "Wether field is read only"
},
"association_details": {
"oneOf": [
{
"type": "object",
"description": "if association details is available then it will return the information",
"properties": {
"related_field": {
"type": "object",
"description": "Details of the related field",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"lookup_field": {
"type": "object",
"description": "Details of the lookup field",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
}
},
"required": [
"related_field",
"lookup_field"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"multi_module_lookup": {
"oneOf": [
{
"type": "object",
"description": "if multi module lookup is available then it will return the information",
"properties": {
"display_label": {
"type": "string",
"description": "Display label of the multi module lookup",
"maxLength": 50
},
"api_name": {
"$ref": "#/$defs/ApiName"
},
"modules": {
"type": "array",
"description": "List of modules associated with the multi module lookup",
"items": {
"type": "object",
"description": "Details of the module",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"module_name": {
"type": "string",
"description": "Name of the module",
"maxLength": 50
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"module_name",
"id"
],
"additionalProperties": false
},
"maxItems": 100
}
},
"required": [],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"id": {
"$ref": "#/$defs/Id"
},
"created_time": {
"oneOf": [
{
"type": "string",
"description": "The time when the record was created.",
"format": "date-time"
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"filterable": {
"type": "boolean",
"description": "Indicates if the field is filterable"
},
"visible": {
"type": "boolean",
"description": "Indicates if the field is visible"
},
"view_type": {
"type": "object",
"description": "View type details of the field",
"properties": {
"view": {
"type": "boolean",
"description": "Indicates if the field is viewable"
},
"edit": {
"type": "boolean",
"description": "Indicates if the field is editable"
},
"quick_create": {
"type": "boolean",
"description": "Indicates if the field supports quick create"
},
"create": {
"type": "boolean",
"description": "Indicates if the field supports create"
}
},
"required": [
"view",
"edit",
"quick_create",
"create"
],
"additionalProperties": false
},
"separator": {
"type": "boolean",
"description": "Indicates if the field is a separator"
},
"searchable": {
"type": "boolean",
"description": "Indicates if the field is searchable"
},
"history_tracking_enabled": {
"type": "boolean",
"description": "Indicates if history tracking is enabled for the field"
},
"external": {
"oneOf": [
{
"type": "object",
"description": "if external is available then it will return the information",
"properties": {
"show": {
"type": "boolean",
"description": "Indicates if the external field is shown"
},
"type": {
"type": "string",
"description": "Indicates the type of the external field",
"maxLength": 50
}
},
"required": [
"show",
"type"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"api_name": {
"$ref": "#/$defs/ApiName"
},
"parent_field": {
"oneOf": [
{
"type": "object",
"description": "if parent field is available then it will return the information",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"name": {
"type": "string",
"description": "Name of the parent field",
"maxLength": 50
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"name",
"id"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"unique": {
"type": "object",
"description": "Uniqueness details of the field",
"properties": {
"case_sensitive": {
"type": "boolean",
"description": "Indicates if the uniqueness is case sensitive"
}
},
"required": [],
"additionalProperties": false
},
"enable_colour_code": {
"type": "boolean",
"description": "Indicates if colour code is enabled for the field"
},
"child_fields": {
"oneOf": [
{
"type": "array",
"description": "List of child fields associated with the Address field ",
"items": {
"type": "object",
"description": "Details of a child Address fields",
"properties": {
"sequence_number": {
"type": "number",
"description": "Sequence number of the child field present in the Address field",
"format": "int32"
},
"field": {
"type": "object",
"description": "Details of the child Address field",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"name": {
"type": "string",
"description": "Name of the child Address field",
"maxLength": 100
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"name",
"id"
],
"additionalProperties": false
}
},
"required": [
"sequence_number",
"field"
],
"additionalProperties": false
},
"maxItems": 100
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"pick_list_values": {
"oneOf": [
{
"type": "array",
"description": "List of pick list values for the field",
"items": {
"type": "object",
"description": "Details of a pick list value",
"properties": {
"display_value": {
"type": "string",
"description": "The display value of the pick list option",
"maxLength": 120
},
"sequence_number": {
"type": "number",
"description": "The sequence number of the pick list option",
"format": "int32"
},
"reference_value": {
"type": "string",
"description": "The reference value of the pick list option",
"maxLength": 120
},
"colour_code": {
"type": "string",
"description": "The colour code associated with the pick list option",
"maxLength": 20
},
"actual_value": {
"type": "string",
"description": "The actual value of the pick list option",
"maxLength": 120
},
"id": {
"$ref": "#/$defs/Id"
},
"type": {
"type": "string",
"description": "The type of the pick list option",
"maxLength": 50
}
},
"required": [
"display_value",
"sequence_number",
"reference_value",
"actual_value",
"id",
"type"
],
"additionalProperties": false
},
"maxItems": 100
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"system_mandatory": {
"type": "boolean",
"description": "Indicates if the field is system mandatory"
},
"private": {
"oneOf": [
{
"type": "object",
"description": "If the field is private, it will return the information",
"properties": {
"restricted": {
"type": "boolean",
"description": "Indicates if the field is restricted"
},
"type": {
"type": "string",
"description": "The type of privacy",
"maxLength": 25
},
"export": {
"type": "boolean",
"description": "Indicates if the field is exportable"
}
},
"required": [
"restricted",
"type",
"export"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"virtual_field": {
"type": "boolean",
"description": "Indicates if the field is a virtual field"
},
"json_type": {
"type": "string",
"description": "JSON type of the field",
"maxLength": 25
},
"crypt": {
"oneOf": [
{
"type": "object",
"description": "If encryption is enabled for the field, it will return the information",
"properties": {
"mode": {
"type": "string",
"description": "The encryption mode used",
"maxLength": 25
},
"encrypt_case": {
"oneOf": [
{
"type": "string",
"description": "Details of the encryption case",
"maxLength": 25
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"status": {
"type": "number",
"description": "The status of the encryption",
"format": "int32"
}
},
"required": [
"mode",
"status"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"range": {
"oneOf": [
{
"type": "object",
"description": "if range is available then it will return the information",
"properties": {
"from": {
"type": "number",
"description": "The starting value of the range",
"format": "double"
},
"to": {
"type": "number",
"description": "The ending value of the range",
"format": "double"
}
},
"required": [
"from",
"to"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"created_source": {
"type": "string",
"description": "The source from which the field was created",
"maxLength": 60
},
"display_type": {
"type": "number",
"description": "The display type of the field",
"format": "int32"
},
"ui_type": {
"type": "number",
"description": "The UI type of the field",
"format": "int32"
},
"modified_time": {
"oneOf": [
{
"type": "string",
"description": "The time when the record was last modified.",
"format": "date-time"
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"public": {
"type": "boolean",
"description": "Indicates if the field is public"
},
"email_parser": {
"type": "object",
"description": "Email parser details of the field",
"properties": {
"fields_update_supported": {
"type": "boolean",
"description": "Indicates if field updates are supported by email parser"
},
"record_operations_supported": {
"type": "boolean",
"description": "Indicates if record operations are supported by email parser"
}
},
"required": [
"fields_update_supported",
"record_operations_supported"
],
"additionalProperties": false
},
"currency": {
"oneOf": [
{
"type": "object",
"description": "If currency details are available, it will return the information",
"properties": {
"rounding_option": {
"type": "string",
"description": "Rounding option for the currency",
"maxLength": 25
},
"precision": {
"type": "number",
"description": "Precision of the currency",
"format": "int32"
}
},
"required": [],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"custom_field": {
"type": "boolean",
"description": "Indicates if the field is a custom field"
},
"lookup": {
"oneOf": [
{
"type": "object",
"description": "Lookup field details",
"properties": {
"display_label": {
"type": "string",
"description": "Display label of the lookup field",
"maxLength": 50
},
"revalidate_filter_during_edit": {
"type": "boolean",
"description": "Indicates if the filter should be revalidated during edit"
},
"api_name": {
"$ref": "#/$defs/ApiName"
},
"module": {
"type": "object",
"description": "Module details for the lookup field",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"crypt": {
"type": "boolean",
"description": "Indicates if the module is encrypted"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"crypt",
"id"
],
"additionalProperties": false
},
"id": {
"$ref": "#/$defs/Id"
},
"query_details": {
"type": "object",
"description": "Query details for the lookup field",
"properties": {
"system_query_id": {
"oneOf": [
{
"type": "string",
"description": "System query ID for the lookup field",
"format": "int64",
"maxLength": 30
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"query_id": {
"type": "string",
"description": "Query ID for the lookup field",
"format": "int64",
"maxLength": 30
}
},
"required": [
"system_query_id"
],
"additionalProperties": false
}
},
"required": [],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"hipaa_compliance": {
"oneOf": [
{
"type": "object",
"description": "If HIPAA compliance is enabled for the field, it will return the information",
"properties": {
"restricted_in_export": {
"type": "boolean",
"description": "Indicates if the field is restricted in export"
},
"restricted": {
"type": "boolean",
"description": "Indicates if the field is restricted"
}
},
"required": [
"restricted_in_export",
"restricted"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"convert_mapping": {
"type": "object",
"description": "Convert mapping details of the field",
"properties": {
"Contacts": {
"oneOf": [
{
"type": "string",
"description": "Mapping details for Contacts field name",
"maxLength": 100
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"Deals": {
"oneOf": [
{
"type": "string",
"description": "Mapping details for Contacts field name",
"maxLength": 100
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"Accounts": {
"oneOf": [
{
"type": "string",
"description": "Mapping details for Contacts field name",
"maxLength": 100
},
{
"$ref": "#/$defs/TypeNull"
}
]
}
},
"required": [],
"additionalProperties": false
},
"address": {
"oneOf": [
{
"type": "object",
"description": "If address details are available, it will return the information",
"properties": {
"type": {
"type": "string",
"description": "The type of address",
"maxLength": 25
}
},
"required": [
"type"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"rollup_summary": {
"oneOf": [
{
"type": "object",
"description": "If rollup summary details are available, it will return the information",
"properties": {
"return_type": {
"type": "string",
"description": "The return type of the rollup summary",
"maxLength": 50
},
"expression": {
"type": "object",
"description": "Expression details of the rollup summary",
"properties": {
"function_parameters": {
"type": "array",
"description": "List of function parameters for the rollup summary",
"items": {
"type": "object",
"description": "Details of a function parameter",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
}
},
"required": [
"api_name"
],
"additionalProperties": false
},
"maxItems": 100
},
"criteria": {
"oneOf": [
{
"type": "object",
"description": "Criteria details for the rollup summary",
"properties": {
"comparator": {
"type": "string",
"description": "The comparator used in the criteria",
"maxLength": 25
},
"field": {
"type": "object",
"description": "Details of the field used in the criteria",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the field",
"maxLength": 100
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"type": {
"type": "string",
"description": "The type of the criteria",
"maxLength": 25
},
"value": {
"type": "string",
"description": "The value used in the criteria",
"maxLength": 100
}
},
"required": [
"comparator",
"field",
"type",
"value"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"function": {
"type": "string",
"description": "The function used in the rollup summary",
"maxLength": 25
}
},
"required": [
"function_parameters",
"function"
],
"additionalProperties": false
},
"based_on_module": {
"type": "object",
"description": "Module on which the rollup summary is based",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"related_list": {
"type": "object",
"description": "Related list details for the rollup summary",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"rollup_based_on": {
"type": "string",
"description": "Indicates what the rollup is based on",
"maxLength": 50
}
},
"required": [],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"length": {
"type": "number",
"description": "The length of the field",
"format": "int32"
},
"column_name": {
"type": "string",
"description": "The column name of the field",
"maxLength": 100
},
"display_field": {
"type": "boolean",
"description": "Indicates if the field is a display field"
},
"pick_list_values_sorted_lexically": {
"type": "boolean",
"description": "Indicates if the pick list values are sorted lexically"
},
"sortable": {
"type": "boolean",
"description": "Indicates if the field is sortable"
},
"global_picklist": {
"oneOf": [
{
"type": "object",
"description": "If global picklist details are available, it will return the information",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"display_format": {
"oneOf": [
{
"type": "string",
"description": "If display format is available, it will return the information",
"maxLength": 50
},
{
"$ref": "#/$defs/TypeNull"
}
]
},
"history_tracking": {
"oneOf": [
{
"type": "object",
"description": "History tracking details of the field",
"properties": {
"related_list_name": {
"type": "string",
"description": "The name of the related list for history tracking",
"maxLength": 100
},
"module": {
"type": "object",
"description": "Module details for history tracking",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"duration_configured_field": {
"type": "object",
"description": "Duration configured field details for history tracking",
"properties": {
"api_name": {
"$ref": "#/$defs/ApiName"
},
"id": {
"$ref": "#/$defs/Id"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
# --- truncated at 32 KB (50 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoho/refs/heads/main/json-schema/zoho-coql-field-schema-schema.json
Work with this as data
Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for schemas
4 MCP tools reach this
find_json_schemasBrowse and filter every JSON Schema in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/zoho-coql-field-schema"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.