Zoho: Coql schemas

← Coql operations · All schemas

Retrieve records using a COQL query — response body — data, fields, info fields value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM field configuration in the Zoho CRM organization, including its metadata, display properties, and operational settings. Additional keys: not allowed
additional_column	JSON	Optional	Represents the name of the additional database column associated with the field, if applicable.
additional_column (anyOf 1)	string	Alternative	Represents the additional column name configuration for the field. Maximum length: 100
additional_column (anyOf 2)	null	Alternative	Represents the null if no information is available.
address	JSON	Optional	Represents the address configuration associated with the field, applicable when the field is of an address type.
address (anyOf 1)	object	Alternative	Represents the address type configuration for the field. Additional keys: not allowed
address (anyOf 1).type	string	Required within parent	Represents the address type for this field configuration. Maximum length: 25
address (anyOf 2)	null	Alternative	Represents the null if no information is available.
api_name	string	Required within parent	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_]*$
associated_module	JSON	Optional	Represents the module associated with this field, such as a subform module.
associated_module (anyOf 1)	object	Alternative	Represents the associated module details for the field, such as a subform module. Additional keys: not allowed
associated_module (anyOf 1).id	string	Required within parent	Id of the resource. Format: int64
associated_module (anyOf 1).module	string	Required within parent	Represents the name of the module. Maximum length: 100
associated_module (anyOf 2)	null	Alternative	Represents the null if no information is available.
association_details	JSON	Required within parent	Represents the association configuration for lookup-type fields, including the related field and lookup field details.
association_details (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value association details lookup field, related field
association_details (anyOf 2)	null	Alternative	Represents the null if no information is available.
auto_number	JSON	Required within parent	Represents the auto-number configuration for the field, if the field uses auto-numbering.
auto_number (anyOf 1)	object	Alternative	Represents the auto-number settings for the field, including prefix, suffix, and starting values. Additional keys: not allowed
auto_number (anyOf 1).prefix	string	Optional	Represents the prefix added before each auto-number value. Maximum length: 25
auto_number (anyOf 1).start_number	JSON	Optional
auto_number (anyOf 1).start_number (anyOf 1)	number	Alternative	Represents the initial numeric value from which the auto-number sequence begins. Format: int32
auto_number (anyOf 1).start_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_number (anyOf 1).starting_number_length	JSON	Optional
auto_number (anyOf 1).starting_number_length (anyOf 1)	number	Alternative	Represents the digit length of the starting auto-number value. Format: int32
auto_number (anyOf 1).starting_number_length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_number (anyOf 1).suffix	string	Optional	Represents the suffix appended after each auto-number value. Maximum length: 25
auto_number (anyOf 2)	null	Alternative	Represents the null if no information is available.
blueprint_supported	boolean	Optional	Indicates whether the field is supported in Blueprint configurations. Possible values: **true** - The field is supported in Blueprint configurations. **false** - The field is not supported in Blueprint configurations.
child_fields	JSON	Optional	Represents the list of child fields associated with this field, applicable for address-type fields.
child_fields (anyOf 1)	array	Alternative	Represents the list of child field entries within an address field configuration. Maximum items: 100
child_fields (anyOf 1)[]	object	Each item	Represents a child field entry within an address field configuration. Additional keys: not allowed
child_fields (anyOf 1)[].field	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value child fields array item field
child_fields (anyOf 1)[].sequence_number	JSON	Required within parent
child_fields (anyOf 1)[].sequence_number (anyOf 1)	number	Alternative	Represents the display sequence of the child field within the address field. Format: int32
child_fields (anyOf 1)[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
child_fields (anyOf 2)	null	Alternative	Represents the null if no information is available.
colour_code_enabled_by_system	boolean	Required within parent	Indicates whether a color code is enabled by the system for this field. Possible values: **true** - A color code is enabled by the system. **false** - No color code is enabled by the system.
column_name	string	Required within parent	Represents the database column name used to store the field value. Maximum length: 100
convert_mapping	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value convert mapping
created_source	string	Required within parent	Represents the source through which this field was added to the organization. Maximum length: 60
created_time	JSON	Optional	Represents the creation timestamp of the field, in ISO 8601 format.
created_time (anyOf 1)	string	Alternative	Represents the creation timestamp of the field, in ISO 8601 date-time format. Format: date-time
created_time (anyOf 2)	null	Alternative	Represents the null if no information is available.
crypt	JSON	Optional	Represents the encryption configuration for the field, if data encryption is enabled.
crypt (anyOf 1)	object	Alternative	Represents the encryption settings for the field, including mode and status. Additional keys: not allowed
crypt (anyOf 1).encrypt_case	JSON	Optional	Represents the encryption case configuration applied to this field.
crypt (anyOf 1).encrypt_case (anyOf 1)	string	Alternative	Represents the encryption case configuration applied to this field. Maximum length: 25
crypt (anyOf 1).encrypt_case (anyOf 2)	null	Alternative	Represents the null if no information is available.
crypt (anyOf 1).mode	string	Required within parent	Represents the encryption mode applied to this field. Maximum length: 25
crypt (anyOf 1).status	JSON	Required within parent
crypt (anyOf 1).status (anyOf 1)	number	Alternative	Represents the current encryption status of the field. Format: int32
crypt (anyOf 1).status (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
crypt (anyOf 2)	null	Alternative	Represents the null if no information is available.
currency	JSON	Required within parent	Represents the currency configuration for the field, applicable when the field stores monetary values.
currency (anyOf 1)	object	Alternative	Represents the currency settings for the field, including precision and rounding options. Additional keys: not allowed
currency (anyOf 1).precision	JSON	Optional
currency (anyOf 1).precision (anyOf 1)	number	Alternative	Represents the number of decimal places used for the currency value. Format: int32
currency (anyOf 1).precision (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency (anyOf 1).rounding_option	string	Optional	Represents the rounding option applied to the currency value. Maximum length: 25
currency (anyOf 2)	null	Alternative	Represents the null if no information is available.
custom_field	boolean	Required within parent	Indicates whether the field is a custom field created by the organization. Possible values: **true** - The field is a custom field. **false** - The field is a default system field.
customizable_properties	JSON	Optional	Represents the list of properties for this field that can be customized by the organization.
customizable_properties (anyOf 1)	array	Alternative	Represents the list of property names that can be customized for this field. Maximum items: 100
customizable_properties (anyOf 1)[]	string	Each item	Represents a customizable property name for the field. Maximum length: 50
customizable_properties (anyOf 2)	null	Alternative	Represents the null if no information is available.
data_type	string	Required within parent	Represents the data type of the field. Maximum length: 25
decimal_place	JSON	Optional	Represents the number of decimal places configured for the field, if the field stores decimal values.
decimal_place (anyOf 1)	JSON	Alternative
decimal_place (anyOf 1) (anyOf 1)	number	Alternative	Represents the decimal precision configuration for the field. Format: int32
decimal_place (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
decimal_place (anyOf 2)	null	Alternative	Represents the null if no information is available.
default_value	JSON	Required within parent
display_field	boolean	Required within parent	Indicates whether the field is configured as a display field. Possible values: **true** - The field is a display field. **false** - The field is not a display field.
display_format	JSON	Optional	Represents the display format string for the field, such as a date or number format pattern.
display_format (anyOf 1)	string	Alternative	Represents the display format pattern for the field. Maximum length: 50
display_format (anyOf 2)	null	Alternative	Represents the null if no information is available.
display_format_properties	JSON	Optional	Represents the additional display format properties for the field, applicable when the field has specific rendering requirements.
display_format_properties (anyOf 1)	object	Alternative	Represents the additional display format properties for the field. Additional keys: not allowed
display_format_properties (anyOf 1).radio_display_type	string	Optional	Represents the display type for a radio button field. Maximum length: 25
display_format_properties (anyOf 1).split	JSON	Optional
display_format_properties (anyOf 1).split (anyOf 1)	number	Alternative	Represents the split configuration value for a phone-type field. Format: int32
display_format_properties (anyOf 1).split (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
display_format_properties (anyOf 2)	null	Alternative	Represents the null if no information is available.
display_label	string	Required within parent	Represents the display label shown to users for this field. Maximum length: 50
display_type	JSON	Required within parent
display_type (anyOf 1)	number	Alternative	Represents the display type identifier for the field. Format: int32
display_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
email_parser	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value email parser
enable_colour_code	boolean	Required within parent	Indicates whether color coding is enabled for this field. Possible values: **true** - Color coding is enabled for the field. **false** - Color coding is not enabled for the field.
external	JSON	Required within parent	Represents the external field configuration, applicable when the field is associated with an external system.
external (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value external show, type
external (anyOf 2)	null	Alternative	Represents the null if no information is available.
field_label	string	Required within parent	Represents the display label of the field as shown in the Zoho CRM interface. Maximum length: 50
field_read_only	boolean	Required within parent	Indicates whether the field is configured as read-only. Possible values: **true** - The field is read-only and cannot be modified. **false** - The field can be modified.
filterable	boolean	Required within parent	Indicates whether the field can be used as a filter criterion. Possible values: **true** - The field supports filtering. **false** - The field does not support filtering.
formula	JSON	Required within parent	Represents the formula configuration for the field, if the field value is computed using a formula.
formula (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value formula assume default, dynamic, return type, stop compute conditionally, sub return type
formula (anyOf 2)	null	Alternative	Represents the null if no information is available.
generated_type	JSON	Required within parent
generated_type (anyOf 1)	integer	Alternative	Represents the integer identifier indicating the type or method used to generate this field. Format: int32
generated_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
global_picklist	JSON	Optional	Represents the global picklist configuration associated with the field, if the field's picklist values are sourced from a global picklist.
global_picklist (anyOf 1)	object	Alternative	Represents the global picklist configuration linked to this field. Additional keys: not allowed
global_picklist (anyOf 1).api_name	string	Required within parent	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_]*$
global_picklist (anyOf 1).id	string	Required within parent	Id of the resource. Format: int64
global_picklist (anyOf 2)	null	Alternative	Represents the null if no information is available.
hipaa_compliance	JSON	Optional	Represents the HIPAA compliance configuration for the field, if the field is marked as protected health information.
hipaa_compliance (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value hipaa compliance restricted, restricted in export
hipaa_compliance (anyOf 2)	null	Alternative	Represents the null if no information is available.
history_tracking	JSON	Optional	Represents the history tracking configuration for the field, if field-level change history is enabled.
history_tracking (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value history tracking duration configuration, duration configured field, followed fields, module, related list name
history_tracking (anyOf 2)	null	Alternative	Represents the null if no information is available.
history_tracking_enabled	boolean	Required within parent	Indicates whether history tracking is enabled for this field. Possible values: **true** - History tracking is enabled. **false** - History tracking is not enabled.
id	string	Required within parent	Id of the resource. Format: int64
json_type	string	Optional	Represents the JSON data type used to represent the field value. Maximum length: 25
layout_associations	array	Optional	Represents the list of layouts that include this field. Maximum items: 100
layout_associations[]	object	Each item	Represents a layout entry that includes this field. Additional keys: not allowed
layout_associations[].api_name	string	Required within parent	Represents the API name of the layout. Maximum length: 25
layout_associations[].id	string	Required within parent	Id of the resource. Format: int64
layout_associations[].name	string	Required within parent	Represents the display name of the layout. Maximum length: 25
length	JSON	Optional
length (anyOf 1)	number	Alternative	Represents the maximum character or digit length allowed for the field value. Format: int32
length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lookup	JSON	Required within parent	Represents the lookup configuration for the field, applicable when the field references records from another module.
lookup (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit
lookup (anyOf 2)	null	Alternative	Represents the null if no information is available.
lucene_colname	string	Required within parent	Represents the Lucene index column name used for full-text search on this field. Maximum length: 1000
modified_time	JSON	Optional	Represents the date and time when the field was last modified, in ISO 8601 format.
modified_time (anyOf 1)	string	Alternative	Represents the date and time when the field was last modified, in ISO 8601 date-time format. Format: date-time
modified_time (anyOf 2)	null	Alternative	Represents the null if no information is available.
multi_module_lookup	JSON	Required within parent	Represents the multi-module lookup configuration for the field, applicable when the field can reference records from multiple modules.
multi_module_lookup (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multi module lookup api name, display label, modules
multi_module_lookup (anyOf 2)	null	Alternative	Represents the null if no information is available.
multiselectlookup	JSON	Required within parent	Represents the multi-select lookup configuration for the field, applicable when the field links to a many-to-many relationship module.
multiselectlookup (anyOf 1)	object	Alternative	Represents the multi-select lookup configuration, including linking module and connected module details. Additional keys: not allowed
multiselectlookup (anyOf 1).connected_details	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details
multiselectlookup (anyOf 1).linking_details	object	Optional	Represents the linking module configuration that manages the many-to-many relationship. Additional keys: not allowed
multiselectlookup (anyOf 1).linking_details.connected_lookup_field	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list linking details connected lookup field
multiselectlookup (anyOf 1).linking_details.lookup_field	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list linking details lookup field
multiselectlookup (anyOf 1).linking_details.module	object	Required within parent	Represents the linking module that manages the many-to-many relationship. Additional keys: not allowed
multiselectlookup (anyOf 1).linking_details.module.api_name	string	Required within parent	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_]*$
multiselectlookup (anyOf 1).linking_details.module.id	string	Required within parent	Id of the resource. Format: int64
multiselectlookup (anyOf 1).linking_details.module.plural_label	string	Required within parent	Represents the plural display label of the linking module. Maximum length: 25
multiselectlookup (anyOf 1).linking_details.module.visibility	JSON	Required within parent
multiselectlookup (anyOf 1).linking_details.module.visibility (anyOf 1)	number	Alternative	Represents the visibility setting of the linking module. Format: int32
multiselectlookup (anyOf 1).linking_details.module.visibility (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
multiselectlookup (anyOf 1).related_list	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list related list
multiselectlookup (anyOf 2)	null	Alternative	Represents the null if no information is available.
multiuserlookup	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup
operation_type	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value operation type
parent_field	JSON	Optional	Represents the parent field configuration, applicable when this field is a sub-field within a parent field such as an address.
parent_field (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value parent field api name, id, name
parent_field (anyOf 2)	null	Alternative	Represents the null if no information is available.
pick_list_values	JSON	Required within parent	Represents the list of available picklist option values for the field, if the field is of a picklist type.
pick_list_values (anyOf 1)	array	Alternative	Represents the list of picklist options configured for the field. Maximum items: 100
pick_list_values (anyOf 1)[]	object	Each item	Represents a picklist option for the field. Additional keys: not allowed
pick_list_values (anyOf 1)[].actual_value	string	Required within parent	Represents the actual stored value of the picklist option. Maximum length: 120
pick_list_values (anyOf 1)[].colour_code	string	Optional	Represents the color code associated with this picklist option. Maximum length: 20
pick_list_values (anyOf 1)[].display_value	string	Required within parent	Represents the display label shown to users for this picklist option. Maximum length: 120
pick_list_values (anyOf 1)[].id	string	Required within parent	Id of the resource. Format: int64
pick_list_values (anyOf 1)[].reference_value	string	Required within parent	Represents the reference value used internally for this picklist option. Maximum length: 120
pick_list_values (anyOf 1)[].sequence_number	JSON	Required within parent
pick_list_values (anyOf 1)[].sequence_number (anyOf 1)	number	Alternative	Represents the display order of the picklist option in the list. Format: int32
pick_list_values (anyOf 1)[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pick_list_values (anyOf 1)[].type	string	Required within parent	Represents the type classification of this picklist option. Maximum length: 50
pick_list_values (anyOf 2)	null	Alternative	Represents the null if no information is available.
pick_list_values_sorted_lexically	boolean	Required within parent	Indicates whether the picklist options are sorted in lexicographic order. Possible values: **true** - The picklist options are sorted lexicographically. **false** - The picklist options follow a custom sequence order.
private	JSON	Optional	Represents the privacy configuration for the field, if the field is marked as private.
private (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value private Represents the privacy settings for the field
private (anyOf 2)	null	Alternative	Represents the null if no information is available.
public	boolean	Required within parent	Indicates whether the field is publicly accessible. Possible values: **true** - The field is publicly accessible. **false** - The field is not publicly accessible.
quick_sequence_number	string	Optional	Represents the sequence number of the field in the quick-create form. Maximum length: 10
range	JSON	Required within parent	Represents the allowed value range for the field, applicable when the field enforces a numeric range.
range (anyOf 1)	object	Alternative	Represents the allowed numeric range configuration for the field. Additional keys: not allowed
range (anyOf 1).from	JSON	Required within parent
range (anyOf 1).from (anyOf 1)	number	Alternative	Represents the minimum allowed value for the field. Format: double
range (anyOf 1).from (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range (anyOf 1).to	JSON	Required within parent
range (anyOf 1).to (anyOf 1)	number	Alternative	Represents the maximum allowed value for the field. Format: double
range (anyOf 1).to (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range (anyOf 2)	null	Alternative	Represents the null if no information is available.
read_only	boolean	Required within parent	Indicates whether the field is read-only in the current context. Possible values: **true** - The field is read-only. **false** - The field is editable.
refer_from_field	JSON	Required within parent	Represents the field from which this field's value is referenced, applicable when the field value is inherited from another field.
refer_from_field (anyOf 1)	null	Alternative	Represents the null state, indicating that no source field is referenced.
refer_from_field (anyOf 2)	object	Alternative	Represents the source field from which this field's value is referenced. Additional keys: not allowed
refer_from_field (anyOf 2).api_name	string	Required within parent	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_]*$
refer_from_field (anyOf 2).id	string	Required within parent	Id of the resource. Format: int64
required	boolean	Required within parent	Indicates whether the field is mandatory for creating or updating a record. Possible values: **true** - The field is mandatory. **false** - The field is optional.
rollup_summary	JSON	Required within parent	Represents the rollup summary configuration for the field, applicable when the field aggregates data from related records.
rollup_summary (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on
rollup_summary (anyOf 2)	null	Alternative	Represents the null if no information is available.
searchable	boolean	Required within parent	Indicates whether the field can be used in search queries. Possible values: **true** - The field is searchable. **false** - The field is not searchable.
separator	boolean	Required within parent	Indicates whether the field acts as a visual separator in the layout. Possible values: **true** - The field is a separator. **false** - The field is a regular field.
sharing_properties	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value sharing properties
sortable	boolean	Required within parent	Indicates whether records can be sorted by this field. Possible values: **true** - The field supports sorting. **false** - The field does not support sorting.
system_mandatory	boolean	Required within parent	Indicates whether the field is marked as mandatory by the system. Possible values: **true** - The field is system-mandatory and cannot be set as optional. **false** - The field is not system-mandatory.
table_name	string	Required within parent	Represents the name of the database table in which the field is stored. Maximum length: 1000
textarea	object	Optional	Represents the textarea configuration for the field, applicable when the field is of a textarea type. Additional keys: not allowed
textarea.type	string	Required within parent	Represents the textarea subtype, such as **Large** for large text areas. Maximum length: 50
tooltip	JSON	Optional	Represents the tooltip configuration for the field, if a tooltip is configured to provide additional guidance to users.
tooltip (anyOf 1)	object	Alternative	Represents the tooltip configuration for the field, including icon name and display text. Additional keys: not allowed
tooltip (anyOf 1).name	string	Required within parent	Represents the icon name used for the tooltip. Maximum length: 25
tooltip (anyOf 1).value	string	Required within parent	Represents the tooltip text displayed to users when they hover over the field. Maximum length: 255
tooltip (anyOf 2)	null	Alternative	Represents the null if no information is available.
type	string	Required within parent	Represents the field type classification. Maximum length: 25
ui_type	JSON	Required within parent
ui_type (anyOf 1)	number	Alternative	Represents the UI type identifier that determines how the field is rendered in the user interface. Format: int32
ui_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unique	object	Required within parent	Represents the uniqueness constraint configuration for the field. Additional keys: not allowed
unique.case_sensitive	boolean	Optional	Indicates whether the uniqueness check for this field is case-sensitive. Possible values: **true** - The uniqueness check is case-sensitive. **false** - The uniqueness check is case-insensitive.
view_type	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value view type
virtual_field	boolean	Required within parent	Indicates whether the field is a virtual field that is computed and not stored directly. Possible values: **true** - The field is virtual. **false** - The field is a stored field.
visible	boolean	Required within parent	Indicates whether the field is visible to users in the Zoho CRM interface. Possible values: **true** - The field is visible. **false** - The field is hidden.
webhook	boolean	Required within parent	Indicates whether webhook notifications are enabled for changes to this field. Possible values: **true** - Webhook notifications are enabled for this field. **false** - Webhook notifications are not enabled for this field.

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value association details lookup field, related field, Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details, Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list linking details connected lookup field, Retrieve records using a COQL query — response body — data, fields, info fields value convert mapping, Retrieve records using a COQL query — response body — data, fields, info fields value email parser, Retrieve records using a COQL query — response body — data, fields, info fields value external show, type, Retrieve records using a COQL query — response body — data, fields, info fields value child fields array item field, Retrieve records using a COQL query — response body — data, fields, info fields value formula assume default, dynamic, return type, stop compute conditionally, sub return type, Retrieve records using a COQL query — response body — data, fields, info fields value hipaa compliance restricted, restricted in export, Retrieve records using a COQL query — response body — data, fields, info fields value history tracking duration configuration, duration configured field, followed fields, module, related list name, Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list linking details lookup field, Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit, Retrieve records using a COQL query — response body — data, fields, info fields value multi module lookup api name, display label, modules, Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup, Retrieve records using a COQL query — response body — data, fields, info fields value operation type, Retrieve records using a COQL query — response body — data, fields, info fields value parent field api name, id, name, Retrieve records using a COQL query — response body — data, fields, info fields value private Represents the privacy settings for the field, Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list related list, Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on, Retrieve records using a COQL query — response body — data, fields, info fields value sharing properties, Retrieve records using a COQL query — response body — data, fields, info fields value view type

Retrieve records using a COQL query — response body — data, fields, info fields value association details lookup field, related field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the association details for a lookup-type field, including the related and lookup field configurations. Additional keys: not allowed
lookup_field	object	Required within parent	Represents the configuration of the lookup field in this association. Additional keys: not allowed
lookup_field.api_name	string	Required within parent	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_]*$
lookup_field.id	string	Required within parent	Id of the resource. Format: int64
related_field	object	Required within parent	Represents the related field linked to this association. Additional keys: not allowed
related_field.api_name	string	Required within parent	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_]*$
related_field.id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value child fields array item field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the configuration details of the child field. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
id	string	Required within parent	Id of the resource. Format: int64
name	string	Required within parent	Represents the name of the child field. Maximum length: 100

Retrieve records using a COQL query — response body — data, fields, info fields value convert mapping

Field	Type	Presence	Description and constraints
$	object	Root	Represents the field mapping configuration used when converting a lead to other CRM modules. Additional keys: not allowed
Accounts	JSON	Optional	Represents the Accounts field API name to which this field is mapped during lead conversion.
Accounts (anyOf 1)	string	Alternative	Represents the Accounts field API name to which this field maps during lead conversion. Maximum length: 100
Accounts (anyOf 2)	null	Alternative	Represents the null if no information is available.
Contacts	JSON	Optional	Represents the Contacts field API name to which this field is mapped during lead conversion.
Contacts (anyOf 1)	string	Alternative	Represents the Contacts field API name to which this field maps during lead conversion. Maximum length: 100
Contacts (anyOf 2)	null	Alternative	Represents the null if no information is available.
Deals	JSON	Optional	Represents the Deals field API name to which this field is mapped during lead conversion.
Deals (anyOf 1)	string	Alternative	Represents the Deals field API name to which this field maps during lead conversion. Maximum length: 100
Deals (anyOf 2)	null	Alternative	Represents the null if no information is available.

Retrieve records using a COQL query — response body — data, fields, info fields value email parser

Field	Type	Presence	Description and constraints
$	object	Root	Represents the email parser configuration for the field, indicating which operations are supported through the email parser. Additional keys: not allowed
fields_update_supported	boolean	Required within parent	Indicates whether the field can be updated through the email parser. Possible values: **true** - Field updates are supported by the email parser. **false** - Field updates are not supported by the email parser.
record_operations_supported	boolean	Required within parent	Indicates whether record operations are supported for this field through the email parser. Possible values: **true** - Record operations are supported by the email parser. **false** - Record operations are not supported by the email parser.

Retrieve records using a COQL query — response body — data, fields, info fields value external show, type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the external field configuration, including visibility and type. Additional keys: not allowed
show	boolean	Required within parent	Indicates whether the external field is visible. Possible values: **true** - The external field is visible. **false** - The external field is hidden.
type	string	Required within parent	Represents the type of external field association, such as **org** for organization-level fields. Maximum length: 50

Retrieve records using a COQL query — response body — data, fields, info fields value formula assume default, dynamic, return type, stop compute conditionally, sub return type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the formula configuration for the field, including return type and computation settings. Additional keys: not allowed
assume_default	boolean	Optional	Indicates whether the formula assumes default values for empty inputs. Possible values: **true** - The formula assumes default values. **false** - The formula does not assume default values.
dynamic	boolean	Optional	Indicates whether the formula is dynamic and recalculated on each access. Possible values: **true** - The formula is dynamic. **false** - The formula is static.
return_type	string	Optional	Represents the data type returned by the formula. Maximum length: 50
stop_compute_conditionally	boolean	Optional	Indicates whether formula computation stops based on a condition. Possible values: **true** - Formula computation stops conditionally. **false** - Formula computation runs to completion.
sub_return_type	string	Optional	Represents the sub-return type of the formula, providing additional type information for string-type formulas. Maximum length: 50

Retrieve records using a COQL query — response body — data, fields, info fields value hipaa compliance restricted, restricted in export

Field	Type	Presence	Description and constraints
$	object	Root	Represents the HIPAA compliance settings for the field. Additional keys: not allowed
restricted	boolean	Required within parent	Indicates whether access to the field is restricted due to HIPAA compliance. Possible values: **true** - Access to the field is restricted. **false** - Access to the field is not restricted.
restricted_in_export	boolean	Required within parent	Indicates whether the field value is restricted from being exported due to HIPAA compliance. Possible values: **true** - The field is restricted in exports. **false** - The field is not restricted in exports.

Retrieve records using a COQL query — response body — data, fields, info fields value history tracking duration configuration, duration configured field, followed fields, module, related list name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the history tracking configuration for the field, including tracked fields and duration settings. Additional keys: not allowed
duration_configuration	string	Required within parent	Represents the duration setting for retaining field change history. Maximum length: 120
duration_configured_field	object	Required within parent	Represents the field used to configure the history tracking duration. Additional keys: not allowed
duration_configured_field.api_name	string	Required within parent	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_]*$
duration_configured_field.id	string	Required within parent	Id of the resource. Format: int64
followed_fields	array	Required within parent	Represents the list of fields whose changes are tracked in the history. Maximum items: 100
followed_fields[]	object	Each item	Represents a field entry whose changes are tracked in the history. Additional keys: not allowed
followed_fields[].api_name	string	Required within parent	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_]*$
followed_fields[].id	string	Required within parent	Id of the resource. Format: int64
module	object	Required within parent	Represents the module associated with the field's history tracking configuration. Additional keys: not allowed
module.api_name	string	Required within parent	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_]*$
module.id	string	Required within parent	Id of the resource. Format: int64
related_list_name	string	Required within parent	Represents the API name of the related list used to store history tracking data. Maximum length: 100

Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field configuration, including the referenced module and filter settings. Additional keys: not allowed
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_]*$
display_label	string	Optional	Represents the display label of the related lookup field. Maximum length: 50
id	string	Optional	Id of the resource. Format: int64
module	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit module
query_details	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit query details
revalidate_filter_during_edit	boolean	Optional	Indicates whether the lookup filter criteria are revalidated when the record is edited. Possible values: **true** - The filter is revalidated during edits. **false** - The filter is not revalidated during edits.

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit module, Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit query details

Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the module from which the lookup field retrieves its records. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
crypt	boolean	Required within parent	Indicates whether the data in the module is encrypted. Possible values: **true** - The module data is encrypted. **false** - The module data is not encrypted.
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value lookup api name, display label, id, module, query details, revalidate filter during edit query details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the system query configuration applied to the lookup field. Additional keys: not allowed
query_id	string	Optional	Represents the query ID associated with this lookup field. Format: int64 Maximum length: 30
system_query_id	JSON	Required within parent	Represents the system-generated query ID for this lookup field.
system_query_id (anyOf 1)	string	Alternative	Represents the system-generated query ID for the lookup field. Format: int64 Maximum length: 30
system_query_id (anyOf 2)	null	Alternative	Represents the null if no information is available.

Retrieve records using a COQL query — response body — data, fields, info fields value multi module lookup api name, display label, modules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-module lookup configuration, including display label, API name, and associated modules. Additional keys: not allowed
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_]*$
display_label	string	Optional	Represents the display label of the multi-module lookup field. Maximum length: 50
modules	array	Optional	Represents the list of modules that this multi-module lookup field can reference. Maximum items: 100
modules[]	Model	Each item	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multi module lookup api name, display label, modules modules item

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value multi module lookup api name, display label, modules modules item

Retrieve records using a COQL query — response body — data, fields, info fields value multi module lookup api name, display label, modules modules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a module entry available for selection in the multi-module lookup. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
id	string	Required within parent	Id of the resource. Format: int64
module_name	string	Required within parent	Represents the API name of the module available in the multi-module lookup. Maximum length: 50

Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected module details for the multi-select lookup field. Additional keys: not allowed
field	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details field
layouts	array	Required within parent	Represents the list of layouts associated with the connected module in the multi-select lookup. Maximum items: 100
layouts[]	object	Each item	Represents a layout entry for the connected module in the multi-select lookup. Additional keys: not allowed
layouts[].api_name	string	Required within parent	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_]*$
layouts[].id	string	Required within parent	Id of the resource. Format: int64
module	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details module

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details field, Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details module

Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the field configuration in the connected module. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
field_label	string	Required within parent	Represents the display label of the field in the connected module. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list connected details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected module in the multi-select lookup configuration. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
id	string	Required within parent	Id of the resource. Format: int64
plural_label	string	Required within parent	Represents the plural display label of the connected module. Maximum length: 25

Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected lookup field in the linking module. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
field_label	string	Required within parent	Represents the display label of the connected lookup field. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field in the linking module. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
field_label	string	Required within parent	Represents the display label of the lookup field. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value multiselectlookup connected details, linking details, related list related list

Field	Type	Presence	Description and constraints
$	object	Root	Represents the related list configuration for the multi-select lookup field. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
display_label	string	Required within parent	Represents the display label of the related list. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup

Field	Type	Presence	Description and constraints
$	object	Root	Represents the multi-user lookup configuration for the field, applicable when the field can reference multiple users. Additional keys: not allowed
linking_details	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details
record_access	boolean	Required within parent	Indicates whether record access is enabled for the multi-user lookup field. Possible values: **true** - Record access is enabled. **false** - Record access is not enabled.

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details

Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the linking module configuration for the multi-user lookup field. Additional keys: not allowed
connected_lookup_field	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details connected lookup field
lookup_field	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details lookup field
module	Model	Required within parent	Expand Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details module

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details connected lookup field, Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details lookup field, Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details module

Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details connected lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the connected lookup field in the multi-user lookup linking module. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
field_label	string	Required within parent	Represents the display label of the connected lookup field in the multi-user lookup. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field in the multi-user lookup linking module. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
field_label	string	Required within parent	Represents the display label of the lookup field in the multi-user lookup. Maximum length: 25
id	string	Required within parent	Id of the resource. Format: int64

Retrieve records using a COQL query — response body — data, fields, info fields value multiuserlookup linking details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the linking module for the multi-user lookup configuration. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
id	string	Required within parent	Id of the resource. Format: int64
plural_label	string	Required within parent	Represents the plural display label of the multi-user lookup module. Maximum length: 25

Retrieve records using a COQL query — response body — data, fields, info fields value operation type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the set of operation types permitted for this field across different contexts. Additional keys: not allowed
api_create	boolean	Required within parent	Indicates whether the field can be set during record creation via the API. Possible values: **true** - The field can be set when creating records via the API. **false** - The field cannot be set during API record creation.
api_update	boolean	Required within parent	Indicates whether the field can be updated via the API. Possible values: **true** - The field can be updated via the API. **false** - The field cannot be updated via the API.
web_create	boolean	Required within parent	Indicates whether the field can be set during record creation via the web interface. Possible values: **true** - The field can be set when creating records via the web interface. **false** - The field cannot be set during web record creation.
web_update	boolean	Required within parent	Indicates whether the field can be updated via the web interface. Possible values: **true** - The field can be updated via the web interface. **false** - The field cannot be updated via the web interface.

Retrieve records using a COQL query — response body — data, fields, info fields value parent field api name, id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the parent field configuration, including API name, display name, and ID. Additional keys: not allowed
api_name	string	Required within parent	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_]*$
id	string	Required within parent	Id of the resource. Format: int64
name	string	Required within parent	Represents the display name of the parent field. Maximum length: 50

Retrieve records using a COQL query — response body — data, fields, info fields value private Represents the privacy settings for the field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the privacy settings for the field. Additional keys: not allowed
export	boolean	Required within parent	Indicates whether the private field can be included in data exports. Possible values: **true** - The field can be exported. **false** - The field is restricted from exports.
restricted	boolean	Required within parent	Indicates whether access to the private field is restricted. Possible values: **true** - Access to the field is restricted. **false** - Access to the field is not restricted.
type	string	Required within parent	Represents the privacy level of the field, such as **High**. Maximum length: 25

Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on

Field	Type	Presence	Description and constraints
$	object	Root	Represents the rollup summary configuration, including the aggregate function, expression, and related module details. Additional keys: not allowed
based_on_module	object	Optional	Represents the module whose records are aggregated in the rollup summary. Additional keys: not allowed
based_on_module.api_name	string	Required within parent	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_]*$
based_on_module.id	string	Required within parent	Id of the resource. Format: int64
expression	Model	Optional	Expand Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on expression
related_list	object	Optional	Represents the related list whose records are used for the rollup aggregation. Additional keys: not allowed
related_list.api_name	string	Required within parent	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_]*$
related_list.id	string	Required within parent	Id of the resource. Format: int64
return_type	string	Optional	Represents the data type of the value returned by the rollup summary. Maximum length: 50
rollup_based_on	string	Optional	Represents the field on which the rollup aggregation is based. Maximum length: 50

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on expression

Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on expression

Field	Type	Presence	Description and constraints
$	object	Root	Represents the expression configuration that defines the rollup calculation. Additional keys: not allowed
criteria	JSON	Optional	Represents the filter criteria applied to records before the rollup aggregation is computed.
criteria (anyOf 1)	Model	Alternative	Expand Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value
criteria (anyOf 2)	null	Alternative	Represents the null if no information is available.
function	string	Required within parent	Represents the aggregate function used in the rollup summary calculation. Maximum length: 25
function_parameters	array	Required within parent	Represents the list of parameters passed to the rollup aggregate function. Maximum items: 100
function_parameters[]	object	Each item	Represents a parameter for the rollup aggregate function. Additional keys: not allowed
function_parameters[].api_name	string	Required within parent	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_]*$

Referenced models: Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value

Retrieve records using a COQL query — response body — data, fields, info fields value rollup summary based on module, expression, related list, return type, rollup based on expression criteria comparator, field, type, value

Field	Type	Presence	Description and constraints
$	object	Root	Represents the filter criteria configuration for the rollup summary. Additional keys: not allowed
comparator	string	Required within parent	Represents the comparison operator used in the rollup filter criteria. Maximum length: 25
field	object	Required within parent	Represents the field used as a criterion in the rollup filter. Additional keys: not allowed
field.api_name	string	Required within parent	Represents the API name of the field used in the rollup filter criteria. Maximum length: 100
field.id	string	Required within parent	Id of the resource. Format: int64
type	string	Required within parent	Represents the type of the rollup filter criteria. Maximum length: 25
value	string	Required within parent	Represents the value compared against the field in the rollup filter criteria. Maximum length: 100

Retrieve records using a COQL query — response body — data, fields, info fields value sharing properties

Field	Type	Presence	Description and constraints
$	object	Root	Represents the data-sharing configuration for the field. Additional keys: not allowed
scheduler_status	string	Required within parent	Represents the scheduler status for the field's sharing configuration. Maximum length: 50
share_permission	string	Required within parent	Represents the sharing permission level configured for the field. Maximum length: 50
share_preference_enabled	boolean	Required within parent	Indicates whether a share preference is configured for this field. Possible values: **true** - Share preference is enabled. **false** - Share preference is not enabled.

Retrieve records using a COQL query — response body — data, fields, info fields value view type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the view type configuration for the field, indicating which form views support this field. Additional keys: not allowed
create	boolean	Required within parent	Indicates whether the field is available in the create form. Possible values: **true** - The field is available in the create form. **false** - The field is not available in the create form.
edit	boolean	Required within parent	Indicates whether the field is available in the edit form. Possible values: **true** - The field is available in the edit form. **false** - The field is not available in the edit form.
quick_create	boolean	Required within parent	Indicates whether the field is available in the quick-create form. Possible values: **true** - The field is available in the quick-create form. **false** - The field is not available in the quick-create form.
view	boolean	Required within parent	Indicates whether the field is visible in the detail view. Possible values: **true** - The field is visible in the detail view. **false** - The field is not visible in the detail view.