Zoho: Layouts schemas (part 1)

← Layouts operations · All schemas

Delete a custom layout — response body

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response body returned when one or more layouts are successfully deleted, containing per-layout deletion results. Additional keys: not allowed
layouts	array	Required within parent	Contains one entry per layout included in the deletion request, each reporting the individual outcome — such as success or failure — for that specific layout. Maximum items: 1 Minimum items: 1
layouts[]	Model	Each item	Expand Delete a custom layout — response body — layouts item

Referenced models: Delete a custom layout — response body — layouts item

Delete a custom layout — response body — layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the outcome of a single layout deletion attempt within a batch operation, including a status code and descriptive message for that layout. Additional keys: not allowed
code	string	Required within parent	Indicates the outcome code returned for the layout deletion attempt. Possible values: `SUCCESS` — the layout deletion completes successfully. Known values: SUCCESS
details	Model	Required within parent	Expand Delete a custom layout — response body — layouts item details
message	string	Required within parent	Contains a descriptive message summarising the outcome of the layout deletion operation, providing context for both successful completions and failure conditions. Maximum length: 500
status	string	Required within parent	Represents the overall processing state of the layout deletion request. Possible values: `success` — the layout was removed as requested. Known values: success

Referenced models: Delete a custom layout — response body — layouts item details

Delete a custom layout — response body — layouts item details

Field	Type	Presence	Description and constraints
$	object	Root	Represents the identifying details of a layout that has been successfully deleted, returned in the deletion response to confirm which layout was removed. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the deleted layout. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layout by ID — request body — query

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
module	string	Required within parent	Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores. Maximum length: 50
mode	string	Optional	One of: all, business_card, quick_create
include	string	Optional	One of: total_profiles, portal_user_types
include_inner_details	string	Optional	Maximum length: 255 Pattern: ^[a-z_]+(\.[a-z_]+)?(,[a-z_]+(\.[a-z_]+)?)*$
include_element_types	string	Optional	One of: field, mirror_field

Get layouts metadata — response body — layouts layouts item actions allowed

Field	Type	Presence	Description and constraints
$	object	Root	Represents the set of Boolean permission flags indicating which operations are permitted on a layout, such as editing, renaming, cloning, deactivating, and deleting. Additional keys: not allowed
clone	boolean	Required within parent	Indicates whether the layout can be duplicated to create a new layout with the same field and section configuration. Possible values: `true` — cloning the layout is permitted; `false` — the layout cannot be cloned.
deactivate	boolean	Required within parent	Indicates whether the layout can be deactivated, preventing it from being assigned to new records while preserving existing associations. Possible values: `true` — deactivating the layout is permitted; `false` — the layout cannot be deactivated.
delete	boolean	Required within parent	Indicates whether the layout can be permanently removed from the module configuration. Possible values: `true` — deleting the layout is permitted; `false` — the layout cannot be deleted.
downgrade	boolean	Required within parent	Indicates whether the layout can be downgraded to a lower-tier configuration or reverted to a previous edition-level feature set. Possible values: `true` — downgrading the layout is permitted; `false` — the layout cannot be downgraded.
edit	boolean	Required within parent	Indicates whether the layout's field arrangement, sections, and configuration can be modified. Possible values: `true` — editing the layout is permitted; `false` — the layout is locked against edits.
rename	boolean	Required within parent	Indicates whether the layout's display name can be changed. Possible values: `true` — renaming the layout is permitted; `false` — the layout name is locked.
set_layout_permissions	boolean	Required within parent	Indicates whether profile-level permission assignments for the layout can be configured. Possible values: `true` — managing layout permissions is permitted; `false` — permission settings cannot be modified for this layout.

Get layouts metadata — response body — layouts layouts item convert mapping value

Field	Type	Presence	Description and constraints
$	JSON	Root	Represents the convert mapping configuration that defines how record field values are transferred across modules during a record conversion operation.
$ (anyOf 1)	object	Alternative	Represents the lead conversion mapping configuration, specifying how fields from the Leads module are mapped to corresponding fields in the Contacts, Deals, and Accounts modules. Additional keys: not allowed
$ (anyOf 1).Accounts	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices
$ (anyOf 1).Contacts	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices
$ (anyOf 1).Deals	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item convert mapping value Accounts, Contacts, Deals Deals
$ (anyOf 2)	object	Alternative	Represents the Quotes module conversion mapping configuration, specifying how fields from a Quote are mapped to corresponding fields in the Invoices and Sales_Orders modules. Additional keys: not allowed
$ (anyOf 2).Invoices	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices
$ (anyOf 2).SalesOrders	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices
$ (anyOf 3)	object	Alternative	Represents the Sales Order conversion mapping configuration, specifying how fields from a Sales Order are mapped to corresponding fields in the Invoices module. Additional keys: not allowed
$ (anyOf 3).Invoices	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices
$ (anyOf 4)	object	Alternative	Represents a null or empty convert mapping object indicating that no field conversion mapping is configured for this field. Maximum fields: 0 Additional keys: not allowed

Referenced models: Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices, Get layouts metadata — response body — layouts layouts item convert mapping value Accounts, Contacts, Deals Deals

Get layouts metadata — response body — layouts layouts item convert mapping value Accounts, Contacts, Deals Deals

Field	Type	Presence	Description and constraints
$	object	Root	Represents the target layout configuration for a module involved in a record conversion, including field-level mapping details that define how source field values are transferred. Additional keys: not allowed
display_label	string	Required within parent	Represents the label of the target module's layout as it appears in the CRM interface during record conversion. This variant is accompanied by field-level mapping details. Maximum length: 255
fields	array	Required within parent	Contains the collection of field configurations belonging to the target module's layout that participate in the record conversion process, each describing how a specific field is handled during the transfer of data. Maximum items: 100
fields[]	object	Each item	Represents a single field entry within the target module's layout, capturing the field's label and any constraints that apply when transferring record data during conversion. Additional keys: not allowed
fields[].api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the field in the target module. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
fields[].field_label	string	Required within parent	Represents the name of the field as it appears in the CRM interface within the target module's layout during record conversion. Maximum length: 255
fields[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the field. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
fields[].required	boolean	Required within parent	Indicates whether the field must be populated for the record conversion to proceed successfully. Possible values: `true` — the field is mandatory and a value must be provided before conversion can complete; `false` — the field is optional and may be left unpopulated during conversion.
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the target layout. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the unique API name that programmatically identifies the target layout within the conversion mapping configuration. This variant is accompanied by field-level mapping details. Maximum length: 255

Get layouts metadata — response body — layouts layouts item convert mapping value Invoices Invoices

Field	Type	Presence	Description and constraints
$	object	Root	Represents the target layout configuration for a module involved in a record conversion operation, identifying the layout by its API name and display label. Additional keys: not allowed
display_label	string	Required within parent	Represents the label of the target module's layout as it appears in the CRM interface during record conversion. Maximum length: 255
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the target layout. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the unique API name that programmatically identifies the target layout within the conversion mapping configuration. Maximum length: 255

Get layouts metadata — response body — layouts layouts item created by id, name

Field	Type	Presence	Description and constraints
$	object	Root	Represents a reference to the CRM user who performed an action, such as creating or modifying a layout, identified by their unique ID and display name. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the display name of the CRM user, shown in audit fields and reference contexts such as created_by and modified_by. Maximum length: 100 Minimum length: 1

Get layouts metadata — response body — layouts layouts item profiles array item

Field	Type	Presence	Description and constraints
$	object	Root	Represents the profile associated with a layout, including the profile's display name, type classification, default view assignment, and whether this is the default layout for that profile. Additional keys: allowed
_default_assignment_view	object	Required within parent	Represents the default view configuration used for record assignment for users belonging to this profile and layout combination. Additional keys: not allowed
_default_assignment_view.id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
_default_assignment_view.name	string	Required within parent	Represents the name of the view used as the default for record assignment for this profile. Maximum length: 100 Minimum length: 1
_default_assignment_view.type	string	Required within parent	Indicates the type of view used for record assignment. Possible values: `canvas` — a custom canvas view; `layout` — a standard field layout. Known values: canvas, layout
_default_view	object	Required within parent	Represents the default view assigned to this profile for the layout, used when users of this profile open a record in the standard detail context. Additional keys: not allowed
_default_view.id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
_default_view.name	string	Required within parent	Represents the name of the default view assigned to this profile for the layout. Maximum length: 100 Minimum length: 1
_default_view.type	string	Required within parent	Indicates the type of the default view assigned to this profile. Possible values: `layout` — a standard field layout; `wizard` — a guided multi-step wizard. Known values: layout, wizard
default	boolean	Required within parent	Indicates whether this profile is the default profile assignment for the layout. Possible values: `true` — this is the default profile; `false` — this is not the default profile.
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the display name of the CRM profile associated with this layout assignment. Maximum length: 60 Minimum length: 1
type	string	Optional	Represents the classification type of the profile, distinguishing between available profile tiers. Possible values: `normal_profile` — a full-access standard CRM profile. `lite_profile` — a restricted-access lite profile. Known values: normal_profile, lite_profile

Get layouts metadata — response body — layouts layouts item sections item actions allowed

Field	Type	Presence	Description and constraints
$	object	Root	Represents the set of Boolean permission flags indicating which modification operations are permitted on a layout section, such as adding fields, renaming, reordering, and deleting. Additional keys: not allowed
add_field	boolean	Required within parent	Indicates whether new fields may be introduced into the layout section. Possible values: `true` — adding fields to the section is permitted; `false` — adding fields to the section is not permitted.
change_column_count	boolean	Required within parent	Indicates whether the number of columns displayed within the layout section may be modified. Possible values: `true` — adjusting the column count for the section is permitted; `false` — adjusting the column count for the section is not permitted.
change_tab_traversal	boolean	Required within parent	Indicates whether the keyboard tab traversal order of fields within the layout section may be modified. Possible values: `true` — changing the tab traversal order is permitted; `false` — changing the tab traversal order is not permitted.
delete	boolean	Required within parent	Indicates whether the layout section may be permanently removed from the layout. Possible values: `true` — deleting the section is permitted; `false` — deleting the section is not permitted.
remove_field	boolean	Required within parent	Indicates whether existing fields may be detached from the layout section. Possible values: `true` — removing fields from the section is permitted; `false` — removing fields from the section is not permitted.
rename	boolean	Required within parent	Indicates whether the display name of the layout section may be changed. Possible values: `true` — renaming the section is permitted; `false` — renaming the section is not permitted.
reorder	boolean	Required within parent	Indicates whether the relative ordering of sections or fields within the layout may be changed. Possible values: `true` — reordering is permitted; `false` — reordering is not permitted.

Get layouts metadata — response body — layouts layouts item sections item fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a comprehensive schema for a CRM field in a module layout, encapsulating all field-level configuration including data type, display settings, permissions, lookup relationships, formula definitions, and audit metadata. Additional keys: not allowed
additional_column	JSON	Optional
additional_column (anyOf 1)	string	Alternative	Represents the additional column configuration for the field, specifying display settings when the field appears as an extra column in module list views. Maximum length: 100
additional_column (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
address	JSON	Optional	Contains the address sub-field configuration applicable when the field represents a composite address type, such as mailing or billing address, grouping individual components like street, city, state, and country into a structured object.
address (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item address type
address (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
allowed_permissions_to_update	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item allowed permissions to update
api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API identifier for the field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
associated_module	JSON	Optional	Contains the details of the CRM module linked to this field when the field represents a subform, identifying the related module and the layout governing how its records are embedded and displayed within the parent module's layout.
associated_module (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item associated module id, layout, module
associated_module (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
association_details	JSON	Optional	Contains the relationship metadata for fields connected to other records through lookup associations, describing the linked module, the nature of the relationship, and any constraints governing how related records appear or display.
association_details (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field
association_details (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
auto_number	JSON	Optional
auto_number (anyOf 1)	object	Alternative	Represents the active auto-number configuration for this field, containing the prefix, suffix, starting number, and digit length used to generate sequential identifiers. Additional keys: not allowed
auto_number (anyOf 1).prefix	JSON	Optional
auto_number (anyOf 1).prefix (anyOf 1)	string	Alternative	Represents the text string prepended to each auto-generated number in the sequence. Maximum length: 10
auto_number (anyOf 1).prefix (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
auto_number (anyOf 1).start_number	JSON	Optional
auto_number (anyOf 1).start_number (anyOf 1)	JSON	Alternative
auto_number (anyOf 1).start_number (anyOf 1) (anyOf 1)	number	Alternative	Represents the numeric value at which the auto-number sequence begins. Format: int32
auto_number (anyOf 1).start_number (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
auto_number (anyOf 1).start_number (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
auto_number (anyOf 1).starting_number_length	JSON	Optional
auto_number (anyOf 1).starting_number_length (anyOf 1)	number	Alternative	Represents the total digit length of the starting number used in the auto-number sequence, controlling zero-padding and minimum width of generated values. 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	JSON	Optional
auto_number (anyOf 1).suffix (anyOf 1)	string	Alternative	Represents the text string appended to each auto-generated number in the sequence. Maximum length: 10
auto_number (anyOf 1).suffix (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
auto_number (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
blueprint_supported	boolean	Optional	Indicates whether the field can participate in Blueprint process definitions, enabling it to be referenced in transition conditions and actions within automated workflow stages. Possible values: `true` — the field is eligible for use in Blueprint configurations; `false` — the field cannot be included in Blueprint process logic.
businesscard_supported	boolean	Optional	Indicates whether the field is eligible to appear on the business card view, which surfaces key record details in compact preview panels across Zoho CRM. Possible values: `true` — the field can be included in the business card layout; `false` — the field is excluded from business card display.
category	JSON	Optional
category (anyOf 1)	number	Alternative	Indicates the classification category of the field, used to group fields by their functional role or origin within the module layout, such as standard, custom, or system-defined categories. Format: int32
category (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
child_fields	JSON	Optional	Contains the ordered collection of sub-fields that compose a composite field, such as the individual address components (street, city, state, country, zip) grouped under a single parent field.
child_fields (anyOf 1)	array	Alternative	Represents the ordered list of child field entries for a composite field such as an address field, each associating a sub-field's identity with its display sequence. Maximum items: 100
child_fields (anyOf 1)[]	object	Each item	Represents a single sub-field entry within a composite field, bundling the field's identity and its display position relative to sibling sub-fields. Additional keys: not allowed
child_fields (anyOf 1)[].field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item 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	Indicates the ordinal position of the child field within the composite field, determining the rendering order of sub-fields in the layout UI. Format: int32 Minimum: 1
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 a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
colour_code_enabled_by_system	boolean	Optional	Indicates whether color-code functionality has been activated for this field by the system platform rather than by a user or administrator. Possible values: `true` — the system has enabled color coding for this field; `false` — color coding on this field is not system-activated.
column_name	string	Optional	Represents the underlying database column identifier mapped to this field, used for direct data-layer references and query construction within the CRM storage layer. Maximum length: 100
convert_mapping	JSON	Optional	Contains the cross-module field mapping configuration that governs how this field's value is transferred to corresponding fields in target modules (such as Accounts, Contacts, Deals, Invoices, or Sales Orders) when a record conversion is performed.
convert_mapping (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Accounts, Contacts, Deals
convert_mapping (anyOf 2)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Invoices, Sales Orders
convert_mapping (anyOf 3)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Invoices
convert_mapping (anyOf 4)	object	Alternative	Represents an empty convert mapping object indicating that no cross-module field mapping is configured for this field. Maximum fields: 0 Additional keys: not allowed
created_source	string	Optional	Indicates the origin channel through which this field originates in the module. Possible values: `default` — the field is part of the standard CRM module definition; `extension` — the field was added through a CRM extension or plug-in package; `integration` — the field was provisioned via a third-party integration. Known values: "" (empty string), default, extension, integration Maximum length: 60
created_time	JSON	Optional	Represents the date and time at which the field definition was first created in the CRM, recorded for audit and chronological tracking purposes.
created_time (anyOf 1)	string	Alternative	Represents the ISO 8601 datetime with timezone offset recording when this field definition was first created in the CRM. Format: date-time
created_time (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
crypt	JSON	Optional	Contains the encryption settings applied to this field, specifying how sensitive data stored in the field is protected at rest within the CRM platform.
crypt (anyOf 1)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
currency	JSON	Optional	Contains the currency-specific display and calculation settings for the field, including the number of decimal places to retain and the rounding strategy applied when storing or presenting monetary values.
currency (anyOf 1)	object	Alternative	Represents the active currency configuration for this field, specifying the decimal precision and rounding rule applied when storing and displaying monetary values. Additional keys: not allowed
currency (anyOf 1).precision	JSON	Optional
currency (anyOf 1).precision (anyOf 1)	number	Alternative	Indicates the number of decimal places retained when storing and displaying currency values for this field, controlling the granularity of monetary amounts. 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	Specifies the rounding rule applied to currency values when the raw amount exceeds the configured precision. Possible values: `round_up` — always rounds the value up. `round_down` — always rounds the value down. `round_off` — rounds to the nearest value. `normal` — no rounding applied. Known values: round_up, round_down, round_off, normal Maximum length: 25
currency (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
custom_field	boolean	Optional	Indicates whether this field was defined by an administrator or developer beyond the standard module schema, rather than being a built-in system field. Possible values: `true` — the field is user-created and does not belong to the default module definition; `false` — the field is a standard, system-defined field.
customizable_properties	JSON	Optional	Contains the set of field attributes that administrators are permitted to modify through the CRM layout editor, such as label, required status, or visibility, reflecting which aspects of the field definition are not locked by the system.
customizable_properties (anyOf 1)	array	Alternative	Represents the list of field attribute names that administrators can modify through the layout editor, with unique values only. Maximum items: 100 Unique items: true
customizable_properties (anyOf 1)[]	string	Each item	Represents the API name of a single field attribute that can be modified by an administrator, identifying a specific configurable aspect of the field such as its label, tooltip, or mandatory setting. Maximum length: 50
customizable_properties (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
data_type	string	Optional	Identifies the data category assigned to the field, such as text, integer, decimal, date, Boolean, picklist, or lookup, which governs validation rules, storage format, and applicable UI controls. Maximum length: 50
decimal_place	JSON	Optional
decimal_place (anyOf 1)	JSON	Alternative
decimal_place (anyOf 1) (anyOf 1)	number	Alternative	Represents the number of decimal places configured for the field, defining the precision applied when storing and displaying fractional values. 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 a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
default_value	JSON	Optional	Represents the pre-populated value automatically applied to this field when a new record is saved, serving as a baseline entry that users can override during data entry.
default_value (anyOf 1)	string	Alternative	Represents the default string or numeric value pre-populated in this field when a new record is saved. Maximum length: 255
default_value (anyOf 2)	boolean	Alternative	Represents the default Boolean value pre-populated in this field when a new record is saved.
default_value (anyOf 3)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
display_field	boolean	Optional	Indicates whether this field is designated as the primary display field for the module, used to represent the record in lookups, related lists, and search results. Possible values: `true` — the field serves as the record's display identifier; `false` — the field is not the primary display field.
display_format	JSON	Optional	Specifies the presentation pattern applied when rendering the field's value in the UI, such as a date format string, a time pattern, or a number format template controlling separators and symbol placement.
display_format (anyOf 1)	string	Alternative	Represents the active display format pattern for this field, such as a date format string or number format template applied when rendering the field's value in the UI. Maximum length: 50
display_format (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
display_format_properties	JSON	Optional	Contains supplementary rendering configuration for field types that require additional display directives beyond a simple format string, such as phone number dial-code positioning or the orientation and layout style of radio button groups.
display_format_properties (anyOf 1)	object	Alternative	Represents the active supplementary rendering configuration for this field type, such as phone split settings or radio button orientation. Additional keys: not allowed
display_format_properties (anyOf 1).radio_display_type	string	Optional	Specifies the layout orientation used to render radio button options in the UI, such as arranging choices horizontally in a row or vertically in a stacked column. Maximum length: 25
display_format_properties (anyOf 1).split	JSON	Optional
display_format_properties (anyOf 1).split (anyOf 1)	number	Alternative	Indicates the formatting pattern applied to split a phone number into its dial-code prefix and local number segments when rendering the field in the UI. 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 a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
display_label	string	Optional	Represents the name of the field displayed in the module layout, used as the visible title in forms, list views, and detail pages. Maximum length: 100 Minimum length: 1
display_type	JSON	Optional
display_type (anyOf 1)	number	Alternative	Indicates the internal numeric code that controls how the field is rendered in the CRM UI, mapping to predefined display modes such as text box, drop-down, or date picker. Format: int32
display_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
element_type	string	Optional	Represents the structural element type of this entry in the layout, distinguishing standard data fields from mirror fields. Possible values: `field` — a standard data field that accepts or displays a value. `mirror_field` — a field that reflects a value from a related module through a lookup relationship. Known values: field, mirror_field Maximum length: 50
enable_colour_code	boolean	Optional	Indicates whether color coding is currently active for this field, allowing field values to be visually differentiated by color in list views and kanban boards. Possible values: `true` — color coding is enabled for the field; `false` — color coding is not active.
enable_record_category	boolean	Optional	Indicates if the record category feature is enabled for this picklist field. Only returned when the record category feature is available.
enable_transition_for_record_category	boolean	Optional	Indicates if transitions between record categories are enabled. Only returned when enable_record_category is true.
external	JSON	Optional	Contains the integration configuration for fields that receive or expose values through external systems, such as third-party connectors or Zoho marketplace extensions.
external (anyOf 1)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
field_label	string	Optional	Represents the label assigned to the field, displayed in forms, detail views, and list columns within the module layout. Maximum length: 100 Minimum length: 1
field_read_only	boolean	Optional	Indicates whether the field is locked against user edits at the field level, independent of profile-based permissions. Possible values: `true` — the field value cannot be modified by users; `false` — the field is editable subject to applicable profile permissions.
file_upolad_optionlist	JSON	Optional	Contains the list of permitted file source options for file-upload fields, defining where users may select files from when populating the field.
file_upolad_optionlist (anyOf 1)	array	Alternative	Represents the list of permitted file upload source options available for this field, each identifying an upload channel by its display label and internal value. Maximum items: 20
file_upolad_optionlist (anyOf 1)[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item file upolad optionlist array item
file_upolad_optionlist (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
filterable	boolean	Optional	Indicates whether the field can be used as a filter criterion in record search, list view filtering, and report conditions. Possible values: `true` — the field is available as a filter option; `false` — the field cannot be used for filtering.
formula	JSON	Optional	Contains the formula configuration for fields whose values are automatically calculated from expressions referencing other fields or functions, rather than being entered directly by users.
formula (anyOf 1)	object	Alternative	Represents the active formula configuration for this calculated field, containing the expression, return type, evaluation order, and any conditional stop logic. Additional keys: allowed
formula (anyOf 1).assume_default	boolean	Optional	Indicates whether null or missing operand values in the formula expression are treated as zero or an equivalent default, rather than causing the formula result to be null. Possible values: `true` — null operands are substituted with default values; `false` — null operands propagate as null through the calculation.
formula (anyOf 1).dynamic	boolean	Required within parent	Indicates whether the formula is recalculated in real time as dependent field values change, rather than being evaluated only at save time. Possible values: `true` — the formula updates dynamically during record editing; `false` — the formula is evaluated only when the record is saved.
formula (anyOf 1).evaluation_order	JSON	Optional
formula (anyOf 1).evaluation_order (anyOf 1)	integer	Alternative	Indicates the relative priority in which this formula field is evaluated when multiple formula fields exist in the same module and share dependencies, ensuring upstream values are resolved before downstream ones. Format: int32 Minimum: 1
formula (anyOf 1).evaluation_order (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
formula (anyOf 1).expression	string	Required within parent	Contains the formula expression string that defines the calculation logic, composed of function calls, field API name references, and operators that the CRM engine evaluates to produce the field's computed value. Maximum length: 3000
formula (anyOf 1).return_type	string	Required within parent	Identifies the data type produced by the formula expression, such as string, integer, decimal, date, or Boolean, which determines how the computed value is stored and displayed. Maximum length: 25
formula (anyOf 1).stop_compute_conditionally	boolean	Required within parent	Indicates whether the formula evaluation halts when a specified logical condition is met. Possible values: `true` — the formula stops computing once the stop condition expression evaluates to true; `false` — the formula computes to completion regardless of intermediate conditions.
formula (anyOf 1).stop_compute_expression	JSON	Required within parent	Contains the logical expression evaluated at runtime to determine whether formula computation should be interrupted. When the expression resolves to true and stop_compute_conditionally is enabled, further formula processing is skipped and the current interim value is retained.
formula (anyOf 1).stop_compute_expression (anyOf 1)	string	Alternative	Represents the active logical expression evaluated to determine whether formula computation should be halted before completion. Maximum length: 3000
formula (anyOf 1).stop_compute_expression (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
formula (anyOf 1).sub_return_type	JSON	Optional	Represents a secondary classification of the formula's output type, refining the primary return type to indicate a more specific data size or unit. Possible values: `small` — a compact representation of the return type. `medium` — a standard-size representation. `large` — a large-size representation.
formula (anyOf 1).sub_return_type (anyOf 1)	string	Alternative	Represents the active secondary type classification for the formula's return value. Possible values: `small` — a compact representation. `medium` — a standard-size representation. `large` — a large-size representation. Known values: small, medium, large Maximum length: 25
formula (anyOf 1).sub_return_type (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
formula (anyOf 2)	object	Alternative	Represents an empty formula configuration object indicating that no formula calculation is configured for this field. Maximum fields: 0 Additional keys: not allowed
global_map_dependency	JSON	Optional	Represents the global map dependency linked to this field, which governs how the field's available values or behavior are influenced by a shared mapping configuration defined at the organization level. Contains identifying metadata for the associated global map dependency, or is absent when no such dependency applies.
global_map_dependency (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item global map dependency id
global_map_dependency (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
global_picklist	JSON	Optional	Represents the organization-level picklist configuration shared across multiple modules that this field draws its allowed values from. When present, the field's pick options are centrally managed through the referenced global picklist rather than defined locally on the field itself.
global_picklist (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item global picklist api name, id
global_picklist (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
hipaa_compliance	JSON	Optional
hipaa_compliance (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item hipaa compliance restricted, restricted in export
hipaa_compliance (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
hipaa_compliance_enabled	boolean	Optional	Indicates whether HIPAA compliance enforcement is active for this field, determining whether the associated HIPAA access and export restrictions are applied at runtime. Possible values: `true` — HIPAA compliance rules are enforced for this field; `false` — HIPAA compliance is not enforced and the field is treated as non-PHI data.
history_tracking	JSON	Optional	Represents the history tracking configuration for this field, capturing how and for how long changes to the field's value are recorded in the audit trail. Includes details about tracked duration, associated modules, related list linkage, and the specific fields whose changes are followed.
history_tracking (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name
history_tracking (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
history_tracking_enabled	boolean	Optional	Indicates whether change history recording is active for this field, controlling whether updates to the field's value are logged in the audit trail. Possible values: `true` — field value changes are captured and retained in history tracking; `false` — changes to this field are not recorded in the audit trail.
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
json_type	string	Optional	Represents the primitive JSON data type used to serialize this field's value in API request and response payloads. Possible values: `string` — a text value. `integer` — a whole number. `boolean` — a true or false value. `double` — a decimal number. `long` — a large integer. `jsonobject` — a structured object. `jsonarray` — an array of values. Known values: jsonarray, integer, string, jsonobject, boolean, double, long Maximum length: 25
length	JSON	Optional
length (anyOf 1)	number	Alternative	Represents the maximum number of characters or digits permitted for this field's value, defining the storage and input boundary enforced by the CRM when records are saved. Format: int32
length (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lookup	JSON	Optional	Represents the lookup configuration that links this field to records in another CRM module, encapsulating the target module reference, the field's API name and display label within that module, and the unique identifier of the lookup relationship.
lookup (anyOf 1)	object	Alternative	Represents the active lookup field configuration, encapsulating the target module reference, the lookup field's API name, display label, unique identifier, and any query filter settings. Additional keys: not allowed
lookup (anyOf 1).api_name	JSON	Optional
lookup (anyOf 1).api_name (anyOf 1)	string	Alternative	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the lookup field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
lookup (anyOf 1).api_name (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
lookup (anyOf 1).display_label	JSON	Optional
lookup (anyOf 1).display_label (anyOf 1)	string	Alternative	Represents the active display label of the lookup field, shown to users in the CRM interface when the lookup relationship is referenced. Maximum length: 50
lookup (anyOf 1).display_label (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
lookup (anyOf 1).id	JSON	Optional	Represents the unique system-generated identifier for the lookup field definition within the target module. May be null for lookups created implicitly by the system rather than explicitly configured by an administrator.
lookup (anyOf 1).id (anyOf 1)	string	Alternative	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
lookup (anyOf 1).id (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
lookup (anyOf 1).module	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit module
lookup (anyOf 1).query_details	JSON	Optional	Contains the query configuration used to filter the selectable records in the lookup dropdown, restricting available options based on field criteria or system-defined query identifiers.
lookup (anyOf 1).query_details (anyOf 1)	object	Alternative	Represents the active query configuration with field-level filter criteria used to narrow the selectable records in the lookup dropdown. Additional keys: not allowed
lookup (anyOf 1).query_details (anyOf 1).criteria	object	Required within parent	Represents the field-level filter condition applied to the lookup query, defining the field, comparison operator, value, and type of criterion used to narrow the set of records displayed in the lookup. Additional keys: not allowed
lookup (anyOf 1).query_details (anyOf 1).criteria.comparator	string	Required within parent	Represents the comparison operator applied when evaluating the filter criterion, such as equals, contains, starts with, or greater than, determining how the field value is tested against the specified filter value. Maximum length: 50
lookup (anyOf 1).query_details (anyOf 1).criteria.field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit query details criteria, query id, system query id criteria field
lookup (anyOf 1).query_details (anyOf 1).criteria.type	string	Required within parent	Indicates whether the filter value is a static literal or a dynamic reference, controlling how the comparison value is resolved at runtime when the lookup list is rendered. Maximum length: 50
lookup (anyOf 1).query_details (anyOf 1).criteria.value	JSON	Optional	Represents the value compared against the selected field when evaluating the lookup filter criterion. Can be a string, number, or Boolean depending on the field type and the configured comparator.
lookup (anyOf 1).query_details (anyOf 1).criteria.value (anyOf 1)	string	Alternative	Represents a string value used as the right-hand operand when evaluating the lookup filter criterion. Maximum length: 255
lookup (anyOf 1).query_details (anyOf 1).criteria.value (anyOf 2)	JSON	Alternative
lookup (anyOf 1).query_details (anyOf 1).criteria.value (anyOf 2) (anyOf 1)	number	Alternative	Represents a numeric value used as the right-hand operand when evaluating the lookup filter criterion.
lookup (anyOf 1).query_details (anyOf 1).criteria.value (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lookup (anyOf 1).query_details (anyOf 1).criteria.value (anyOf 3)	boolean	Alternative	Represents a Boolean value used as the right-hand operand when evaluating the lookup filter criterion.
lookup (anyOf 1).query_details (anyOf 1).criteria.value (anyOf 4)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
lookup (anyOf 1).query_details (anyOf 1).query_id	JSON	Required within parent	Represents the unique identifier of the custom query used to filter the lookup's selectable records, referencing a predefined query configuration that determines which records appear in the dropdown.
lookup (anyOf 1).query_details (anyOf 1).query_id (anyOf 1)	string	Alternative	Represents the custom query identifier as a string value, referencing a predefined query configuration that filters the lookup's selectable records. Format: int64 Maximum length: 30
lookup (anyOf 1).query_details (anyOf 1).query_id (anyOf 2)	JSON	Alternative
lookup (anyOf 1).query_details (anyOf 1).query_id (anyOf 2) (anyOf 1)	integer	Alternative	Represents the custom query identifier as an integer value, referencing a predefined query configuration that filters the lookup's selectable records. Format: int64
lookup (anyOf 1).query_details (anyOf 1).query_id (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lookup (anyOf 1).query_details (anyOf 1).system_query_id	JSON	Required within parent	Represents the system-assigned identifier for a platform-managed query that filters the lookup's record list, used when the filter logic is maintained by the CRM system rather than defined by a custom query.
lookup (anyOf 1).query_details (anyOf 1).system_query_id (anyOf 1)	string	Alternative	Represents the system-assigned query identifier as a string, referencing a platform-managed query that filters the lookup's record list. Format: int64 Maximum length: 30
lookup (anyOf 1).query_details (anyOf 1).system_query_id (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
lookup (anyOf 1).query_details (anyOf 2)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit query details system query id
lookup (anyOf 1).revalidate_filter_during_edit	boolean	Optional	Indicates whether the lookup's filter criteria are re-evaluated each time the record is opened in edit mode, ensuring that the selectable records reflect current field values rather than the values at the time the record was first created. Possible values: `true` — filter criteria are reapplied during edit; `false` — filter criteria are applied only at initial field population.
lookup (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
lookup_field	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item lookup field
mask_details	JSON	Optional	Represents the field masking configuration that controls how the field's stored value is partially or fully hidden from users who do not have permission to view sensitive data, including rules for how many characters are revealed and which profiles can bypass masking.
mask_details (anyOf 1)	object	Alternative	Represents the partial masking configuration where a specified number of characters at the beginning and end of the field value are revealed while the middle portion is masked. Additional keys: not allowed
mask_details (anyOf 1).complete_mask	boolean	Required within parent	Indicates whether the entire field value is hidden from unauthorized users rather than partially revealed. Possible values: `true` — the value is completely obscured; `false` — partial character reveal rules defined by show_first and show_last apply.
mask_details (anyOf 1).profiles	array	Required within parent	Contains the list of CRM profiles whose members are permitted to view the unmasked field value, exempting those users from the masking rules applied to all other profiles. Maximum items: 50
mask_details (anyOf 1).profiles[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles profiles item
mask_details (anyOf 1).show_first	JSON	Required within parent
mask_details (anyOf 1).show_first (anyOf 1)	integer	Alternative	Indicates the number of characters revealed at the start of the field value when partial masking is applied, allowing a prefix of the data to remain visible while the remainder is hidden. Format: int32 Maximum: 50 Minimum: 0
mask_details (anyOf 1).show_first (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mask_details (anyOf 1).show_last	JSON	Required within parent
mask_details (anyOf 1).show_last (anyOf 1)	integer	Alternative	Indicates the number of characters revealed at the end of the field value when partial masking is applied, allowing a suffix of the data to remain visible while the preceding portion is hidden. Format: int32 Maximum: 50 Minimum: 0
mask_details (anyOf 1).show_last (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
mask_details (anyOf 2)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles
mask_details (anyOf 3)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
mass_update	boolean	Optional	Indicates whether this field can be updated simultaneously across multiple records using the mass update operation. Possible values: `true` — the field is available for mass update; `false` — the field cannot be modified through bulk update actions.
modified_time	JSON	Optional	Represents the date and time at which the field's definition or configuration was most recently changed in the CRM, recorded for audit and change-tracking purposes.
modified_time (anyOf 1)	string	Alternative	Represents the ISO 8601 datetime with timezone offset recording when this field's configuration was most recently changed. Format: date-time
modified_time (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
multi_module_lookup	JSON	Optional	Represents the multi-module lookup configuration for fields that can reference records from more than one CRM module within a single lookup relationship, including the participating modules and dynamic addition settings.
multi_module_lookup (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multi module lookup api name, display label, dynamic module addition allowed, modules
multi_module_lookup (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
multiselectlookup	JSON	Optional
multiselectlookup (anyOf 1)	object	Alternative	Represents the active multi-select lookup configuration for this field, including the connected module details, linking module information, and related list configuration. Additional keys: not allowed
multiselectlookup (anyOf 1).connected_details	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details
multiselectlookup (anyOf 1).linking_details	object	Optional	Contains the configuration of the intermediary linking module that joins the source and target modules in a multi-select lookup relationship, including the relevant lookup fields on each side. Additional keys: not allowed
multiselectlookup (anyOf 1).linking_details.connected_lookup_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list linking details connected lookup field
multiselectlookup (anyOf 1).linking_details.lookup_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list linking details lookup field
multiselectlookup (anyOf 1).linking_details.module	object	Required within parent	Represents the intermediary linking module that bridges the source and target modules in a multi-select lookup, storing the join records that implement the many-to-many relationship. Additional keys: not allowed
multiselectlookup (anyOf 1).linking_details.module.api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
multiselectlookup (anyOf 1).linking_details.module.id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
multiselectlookup (anyOf 1).linking_details.module.plural_label	string	Required within parent	Contains the plural display name of the linking module, as shown in navigation and relational UI elements within the CRM. Maximum length: 100
multiselectlookup (anyOf 1).linking_details.module.visibility	JSON	Required within parent
multiselectlookup (anyOf 1).linking_details.module.visibility (anyOf 1)	number	Alternative	Indicates the visibility state of the linking module, controlling whether it appears in the CRM interface and navigation for end users. 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 Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list related list
multiselectlookup (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
multiuserlookup	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup
operation_type	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item operation type
parent_field	JSON	Optional	Represents the parent field reference for nested or composite fields such as address components, identifying the field under which this field is grouped in the module layout.
parent_field (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item parent field api name, id, name
parent_field (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
pick_list_values	JSON	Optional	Contains the list of selectable options defined for a picklist field, each representing a distinct choice that users can select when populating the field on a record.
pick_list_values (anyOf 1)	array	Alternative	Represents the active list of picklist options for this field, ordered by sequence number, each containing the stored value, display label, and associated metadata. Maximum items: 4000
pick_list_values (anyOf 1)[]	object	Each item	Represents a single picklist option, encapsulating the stored value, the display label, and any associated metadata such as color coding, deal category, or forecast information. Additional keys: not allowed
pick_list_values (anyOf 1)[].actual_value	string	Required within parent	Represents the internal value stored in the database when this picklist option is selected, which may differ from the label displayed to the user. Maximum length: 120
pick_list_values (anyOf 1)[].colour_code	JSON	Optional	Represents the color associated with this picklist option when color-coded list views are enabled for the field, used to visually distinguish records by their selected value.
pick_list_values (anyOf 1)[].colour_code (anyOf 1)	string	Alternative	Represents the hexadecimal color code in #RRGGBB format associated with this picklist option when color coding is active. Maximum length: 7 Minimum length: 7 Pattern: ^#[0-9A-Fa-f]{6}$
pick_list_values (anyOf 1)[].colour_code (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
pick_list_values (anyOf 1)[].deal_category	string	Optional	Represents the deal pipeline category classification associated with this picklist option, used to group and report on deals by their stage category. Maximum length: 100
pick_list_values (anyOf 1)[].display_value	string	Required within parent	Represents the label displayed to users for this picklist option in forms, detail views, and filter dropdowns, which may be a localized version of the stored actual value. Maximum length: 120
pick_list_values (anyOf 1)[].forecast_category	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item forecast category
pick_list_values (anyOf 1)[].forecast_type	string	Optional	Indicates the type of forecast behavior associated with this picklist option, classifying how deals at this stage are treated in forecast calculations. Maximum length: 50
pick_list_values (anyOf 1)[].id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the pick list value Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
pick_list_values (anyOf 1)[].maps	array	Required within parent	Contains the dependent picklist mapping configuration for this option, defining which values become available in dependent fields when this option is selected in the parent picklist. Maximum items: 4000
pick_list_values (anyOf 1)[].maps[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item maps item
pick_list_values (anyOf 1)[].probability	JSON	Optional
pick_list_values (anyOf 1)[].probability (anyOf 1)	number	Alternative	Represents the percentage probability of deal closure associated with this picklist option, used in forecast calculations and reporting for deal stage fields. Format: int32 Maximum: 100 Minimum: 0
pick_list_values (anyOf 1)[].probability (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pick_list_values (anyOf 1)[].record_category_value	Model	Optional	Expand Get field metadata by ID — response body — fields item pick list values array item record category value
pick_list_values (anyOf 1)[].reference_value	string	Optional	Represents the system-internal reference identifier for this picklist option, used in cross-field mapping and dependent picklist resolution where the display value alone is insufficient to uniquely identify the 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	Indicates the ordinal position of this picklist option within the field's list of available choices, determining the display order in dropdown menus and filter panels. Format: int32 Minimum: 1
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	Optional	Represents the classification type of this picklist option, distinguishing system-defined choices from user-created ones or categorizing options by their behavioral role within the field. Maximum length: 50
pick_list_values (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
pick_list_values_sorted_lexically	boolean	Optional	Indicates whether the picklist options for this field are automatically sorted in alphabetical order for display, rather than in the administrator-defined sequence order. Possible values: `true` — options are sorted alphabetically; `false` — options appear in the order defined by the administrator.
portal_user_types	array	Optional	Contains the list of portal user type permission configurations for this field, specifying which portal user type categories can view or edit the field's value when accessing records through a customer or partner portal. Maximum items: 50
portal_user_types[]	object	Each item	Represents the permission configuration for a single portal user type, defining the level of access that users of that type have to this field when interacting through the portal. Additional keys: not allowed
portal_user_types[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the portal user type Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
portal_user_types[].name	string	Required within parent	Represents the name of the portal user type, identifying the category of external users whose field permissions are described in this entry. Maximum length: 255
portal_user_types[].permission_type	string	Required within parent	Represents the access level granted to portal users of this type for the field. Possible values: `read_write` — full read and write access; portal users can view and edit the field. `read_only` — view access only; portal users can see but cannot modify the field value. `hidden` — the field is not visible to portal users of this type. Known values: read_write, read_only, hidden
private	JSON	Optional
private (anyOf 1)	object	Alternative	Represents the active privacy configuration for this field, specifying the access restriction type and export suppression settings when the field is marked as private. Additional keys: not allowed
private (anyOf 1).export	boolean	Required within parent	Indicates whether this field's value is included when records are exported from the CRM, subject to the field's privacy settings. Possible values: `true` — the field is included in exports; `false` — the field is excluded from exported data.
private (anyOf 1).restricted	boolean	Required within parent	Indicates whether this field is subject to privacy restrictions that limit its visibility to the record owner and administrators. Possible values: `true` — access to the field value is restricted based on record ownership; `false` — the field is accessible to all users with the appropriate module permissions.
private (anyOf 1).type	string	Required within parent	Represents the privacy restriction level applied to this field. Possible values: `High` — high-level privacy restriction with strict access control. `Low` — low-level privacy restriction with relaxed access control. Known values: High, Low Maximum length: 25
private (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
profiles	array	Optional	Contains the list of profile-level permission entries for this field, each describing the access level a specific CRM profile has to view or edit the field's value. Maximum items: 100 Unique items: true
profiles[]	object	Each item	Represents the permission assignment for a single CRM profile, specifying whether users of that profile can view, edit, or are restricted from accessing this field. Additional keys: not allowed
profiles[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the profile Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
profiles[].name	string	Required within parent	Represents the name of the CRM profile for which this field permission entry applies. Maximum length: 60
profiles[].permission_type	string	Required within parent	Represents the level of access granted to users of this profile for the field. Possible values: `read_write` — full read and write access; users can view and edit the field. `read_only` — view access only; users can see but cannot modify the field value. `hidden` — the field is not visible to users of this profile. Known values: read_write, read_only, hidden Maximum length: 25
public	boolean	Optional	Indicates whether this field's value is accessible to external users or public-facing integrations. Possible values: `true` — the field is marked as public and may be exposed through portals or external APIs; `false` — the field is restricted to internal CRM users.
query_details	JSON	Optional	Contains the query configuration applied to filter the selectable records in this field's lookup or dependent logic, using either custom query identifiers or field-level criteria expressions.
query_details (anyOf 1)	object	Alternative	Represents the active query configuration for this field's lookup filter, using field-level criteria expressions to narrow selectable records. Additional keys: not allowed
query_details (anyOf 1).criteria	object	Required within parent	Represents the field-level filter condition for the query, specifying the field, comparator, type, and value used to narrow down the set of records or options. Additional keys: not allowed
query_details (anyOf 1).criteria.comparator	string	Required within parent	Represents the comparison operator used in the filter criterion, such as equals, contains, or greater than, applied when evaluating whether a record or value satisfies the filter. Maximum length: 25
query_details (anyOf 1).criteria.field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item query details criteria, query id criteria field
query_details (anyOf 1).criteria.type	string	Required within parent	Indicates whether the comparison value in the filter criterion is a static literal or a dynamic contextual reference resolved at runtime. Maximum length: 50
query_details (anyOf 1).criteria.value	JSON	Optional	Represents the value compared against the selected field when evaluating the query filter criterion.
query_details (anyOf 1).criteria.value (anyOf 1)	string	Alternative	Represents a string value used as the comparison operand in the field-level lookup filter criterion. Maximum length: 255
query_details (anyOf 1).criteria.value (anyOf 2)	JSON	Alternative
query_details (anyOf 1).criteria.value (anyOf 2) (anyOf 1)	number	Alternative	Represents a numeric value used as the comparison operand in the field-level lookup filter criterion.
query_details (anyOf 1).criteria.value (anyOf 2) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
query_details (anyOf 1).criteria.value (anyOf 3)	boolean	Alternative	Represents a Boolean value used as the comparison operand in the field-level lookup filter criterion.
query_details (anyOf 1).criteria.value (anyOf 4)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
query_details (anyOf 1).query_id	JSON	Required within parent
query_details (anyOf 1).query_id (anyOf 1)	integer	Alternative	Represents the unique identifier of the custom query used to filter this field's selectable options or lookup results. Format: int64
query_details (anyOf 1).query_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
query_details (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
quick_sequence_number	string	Optional	Represents the ordinal position of this field in the quick-create form layout, determining the display order of fields when users create records through abbreviated entry panels. Maximum length: 10
range	JSON	Optional	Represents the numeric range constraint applied to this field, specifying the minimum and maximum values that the field accepts when a record is saved.
range (anyOf 1)	object	Alternative	Represents the active numeric range constraint for this field, specifying the minimum and maximum allowed values. Additional keys: not allowed
range (anyOf 1).from	JSON	Required within parent
range (anyOf 1).from (anyOf 1)	JSON	Alternative
range (anyOf 1).from (anyOf 1) (anyOf 1)	number	Alternative	Represents the lower bound of the numeric range constraint, defining the minimum value the field accepts. Format: double
range (anyOf 1).from (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range (anyOf 1).from (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
range (anyOf 1).to	JSON	Required within parent
range (anyOf 1).to (anyOf 1)	JSON	Alternative
range (anyOf 1).to (anyOf 1) (anyOf 1)	number	Alternative	Represents the upper bound of the numeric range constraint, defining the maximum value the field accepts. Format: double
range (anyOf 1).to (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
range (anyOf 1).to (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
range (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
read_only	boolean	Optional	Indicates whether this field is locked against user edits through the CRM interface and API, preventing any modification of its value after it has been set. Possible values: `true` — the field cannot be modified; `false` — the field is editable subject to applicable permissions.
record_category_tracking_field	JSON	Optional	Reference to the field used to track record category changes over time in the timeline view. Only present when enable_record_category is true and a tracking field is configured.
record_category_tracking_field (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item record category tracking field api name, id
record_category_tracking_field (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
record_category_values	array	Optional	List of record category values defined for this picklist field. Only returned when enable_record_category is true. Maximum items: 50
record_category_values[]	object	Each item	Individual record category configuration. Additional keys: not allowed
record_category_values[].api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the record category. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
record_category_values[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the record category. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
record_category_values[].nature_of_category	string	Required within parent	Nature of the record category indicating sentiment or outcome. Known values: none, thumbs_up, thumbs_down
record_category_values[].value	string	Required within parent	Display value of the record category. Maximum length: 120
refer_from_field	JSON	Optional	Represents the source field from which this mirror or derived field obtains its value, establishing a read-through relationship where the field reflects data from another field in a related module.
refer_from_field (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item refer from field api name, id
refer_from_field (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
required	boolean	Optional	Indicates whether this field must contain a value before a record can be saved. Possible values: `true` — the field is mandatory and a value must be supplied; `false` — the field is optional.
rollup_summary	JSON	Optional	Represents the rollup summary configuration for this field, defining how aggregated values from related records in a child module are calculated and displayed in the parent record's field.
rollup_summary (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on
rollup_summary (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
searchable	boolean	Optional	Indicates whether this field's value can be used as a search term in the CRM's global and module-level search functionality. Possible values: `true` — the field is indexed for search and returns results when matched; `false` — the field is excluded from search indexing.
section_id	JSON	Optional
section_id (anyOf 1)	number	Alternative	Indicates the numeric identifier of the section within the module layout that contains this field, used to group fields and determine their organizational placement on record forms. Format: int32
section_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
separator	boolean	Optional	Indicates whether this field functions as a visual separator element in the layout rather than a data-entry field. Possible values: `true` — the element is a layout separator that creates a visual break between sections or field groups; `false` — the element is a standard data field.
sequence_number	JSON	Optional
sequence_number (anyOf 1)	number	Alternative	Represents the ordinal position of this field within its containing section, controlling the order in which fields are rendered on record forms. Sequence numbering generally starts from one but may contain gaps. Format: int32 Minimum: 1
sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sharing_properties	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item sharing properties
show_type	JSON	Optional
show_type (anyOf 1)	number	Alternative	Represents the internal numeric code that controls the display behavior or rendering mode of the field in the CRM UI, supplementing the data_type classification with additional display context. Format: int32
show_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sortable	boolean	Optional	Indicates whether records can be sorted by this field's value in list views, reports, and search results. Possible values: `true` — the field is available as a sort key; `false` — the field cannot be used for sorting.
static_field	boolean	Optional	Indicates whether this field is a static layout element with a fixed value that does not accept user input. Possible values: `true` — the field is a static display-only element; `false` — the field accepts dynamic user-entered or system-computed values.
static_values	JSON	Optional	Contains the predefined option list for fields with a fixed set of choices, such as static picklists and radio button fields, where the available values are defined at layout configuration time.
static_values (anyOf 1)	array	Alternative	Represents the active list of static value options available for this field, each containing a sequence number and stored value. Maximum items: 500
static_values (anyOf 1)[]	object	Each item	Represents a single option within the field's static value list, encapsulating the option's display order and the stored value associated with that choice. Additional keys: not allowed
static_values (anyOf 1)[].id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the static value option. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
static_values (anyOf 1)[].sequence_number	JSON	Required within parent
static_values (anyOf 1)[].sequence_number (anyOf 1)	integer	Alternative	Indicates the display order of this static option within the field's predefined choice list, determining the position in which the option appears to users. Format: int32 Minimum: 1
static_values (anyOf 1)[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
static_values (anyOf 1)[].value	string	Required within parent	Represents the stored value for this static option, used as the system identifier and the data written to the record when the option is selected. Maximum length: 255
static_values (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
subform	JSON	Optional	Represents the subform configuration for fields that embed a related module's records inline within the parent module's layout, including the API name of the associated subform module and its subform tab identifier.
subform (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item subform id, module
subform (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
subform_properties	JSON	Optional	Contains the display configuration settings for this field when it appears within a subform section, such as custom column width and column pinning behavior.
subform_properties (anyOf 1)	object	Alternative	Represents the active subform display configuration for this field, specifying column width and pinning behavior when the field appears in a subform section. Additional keys: not allowed
subform_properties (anyOf 1).custom_width	JSON	Required within parent	Indicates the custom column width in pixels assigned to this field when it is displayed as a column in a subform, overriding the default column sizing.
subform_properties (anyOf 1).custom_width (anyOf 1)	JSON	Alternative
subform_properties (anyOf 1).custom_width (anyOf 1) (anyOf 1)	integer	Alternative	Represents the active custom column width in pixels for this field when displayed in a subform section. Format: int32 Maximum: 1000 Minimum: 50
subform_properties (anyOf 1).custom_width (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
subform_properties (anyOf 1).custom_width (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
subform_properties (anyOf 1).pinned_column	boolean	Required within parent	Indicates whether this field's column is frozen in place when users scroll horizontally through a subform, keeping the field visible regardless of scroll position. Possible values: `true` — the column is pinned; `false` — the column scrolls with the subform.
subform_properties (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
system_mandatory	boolean	Optional	Indicates whether this field is enforced as mandatory by the CRM system itself, as opposed to being made required through an administrator's layout configuration. Possible values: `true` — the field is system-level mandatory and cannot be made optional; `false` — the mandatory status is controlled by layout configuration.
textarea	object	Optional	Contains the textarea-specific configuration for fields that render as multi-line text input areas, including details about the text area subtype. Additional keys: not allowed
textarea.type	string	Required within parent	Represents the subtype of the textarea field, distinguishing between multi-line input variants that affect formatting and storage behavior. Possible values: `small` — a compact single-line or short textarea. `large` — a standard multi-line plain text area. `rich_text` — a rich text editor with formatting support. Known values: small, large, rich_text Maximum length: 50
tooltip	JSON	Optional	Represents the tooltip configuration attached to this field, defining contextual help text displayed to users when they hover over or focus on the field in a record form.
tooltip (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item tooltip name, value
tooltip (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
type	string	Optional	Indicates the field's layout usage status, determining whether the field appears in layout sections. Possible values: `used` — the field is placed in at least one layout section. `unused` — the field exists in the module but has no assignment to any section. `all` — the field appears regardless of layout placement status. Known values: all, unused, used Maximum length: 25
ui_type	JSON	Optional
ui_type (anyOf 1)	number	Alternative	Represents the internal numeric code that identifies the UI component type used to render and interact with this field in the CRM interface, such as a text input, date picker, or reference selector. Format: int32
ui_type (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unique	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item unique
validation_rule	JSON	Optional	Represents the Validation Rule configuration applied to this field, referencing the rule that governs acceptable input formats, value ranges, or logical conditions evaluated when a record is saved.
validation_rule (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item validation rule id
validation_rule (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
view_type	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item view type
virtual_field	boolean	Optional	Indicates whether this field is a computed or transient field that exists only at the API layer and does not map to a persistent database column. Possible values: `true` — the field is virtual and its value is derived at runtime; `false` — the field is backed by a database column.
visible	boolean	Optional	Indicates whether this field is currently displayed in the module layout. Possible values: `true` — the field is shown in the layout and visible to users with appropriate permissions; `false` — the field is hidden from the layout.
webhook	boolean	Optional	Indicates whether webhook notifications are triggered when this field's value changes on a record. Possible values: `true` — changes to this field trigger configured webhook endpoints; `false` — field changes do not initiate webhook notifications.

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles profiles item, Get layouts metadata — response body — layouts layouts item sections item fields item address type, Get layouts metadata — response body — layouts layouts item sections item fields item allowed permissions to update, Get layouts metadata — response body — layouts layouts item sections item fields item associated module id, layout, module, Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field, Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details, Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list linking details connected lookup field, Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Invoices, Sales Orders, Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Accounts, Contacts, Deals, Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Invoices, Get layouts metadata — response body — layouts layouts item sections item fields item query details criteria, query id criteria field, Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit query details criteria, query id, system query id criteria field, Get layouts metadata — response body — layouts layouts item sections item fields item child fields array item field, Get layouts metadata — response body — layouts layouts item sections item fields item file upolad optionlist array item, Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item forecast category, Get layouts metadata — response body — layouts layouts item sections item fields item global map dependency id, Get layouts metadata — response body — layouts layouts item sections item fields item global picklist api name, id, Get layouts metadata — response body — layouts layouts item sections item fields item hipaa compliance restricted, restricted in export, Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name, Get layouts metadata — response body — layouts layouts item sections item fields item lookup field, Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list linking details lookup field, Get layouts metadata — response body — layouts layouts item sections item fields item pick list values array item maps item, Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles, Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit module, Get layouts metadata — response body — layouts layouts item sections item fields item multi module lookup api name, display label, dynamic module addition allowed, modules, Get layouts metadata — response body — layouts layouts item sections item fields item multiuserlookup, Get layouts metadata — response body — layouts layouts item sections item fields item operation type, Get layouts metadata — response body — layouts layouts item sections item fields item parent field api name, id, name, Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit query details system query id, Get layouts metadata — response body — layouts layouts item sections item fields item record category tracking field api name, id, Get field metadata by ID — response body — fields item pick list values array item record category value, Get layouts metadata — response body — layouts layouts item sections item fields item refer from field api name, id, Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list related list, Get layouts metadata — response body — layouts layouts item sections item fields item rollup summary based on module, expression, related list, return type, rollup based on, Get layouts metadata — response body — layouts layouts item sections item fields item sharing properties, Get layouts metadata — response body — layouts layouts item sections item fields item subform id, module, Get layouts metadata — response body — layouts layouts item sections item fields item tooltip name, value, Get layouts metadata — response body — layouts layouts item sections item fields item unique, Get layouts metadata — response body — layouts layouts item sections item fields item validation rule id, Get layouts metadata — response body — layouts layouts item sections item fields item view type

Get layouts metadata — response body — layouts layouts item sections item fields item address type

Field	Type	Presence	Description and constraints
$	object	Root	Represents the detailed address sub-field configuration when the field is a composite address type, providing the address category classification. Additional keys: not allowed
type	string	Required within parent	Represents the classification of the address, distinguishing between address categories such as mailing, billing, or shipping to determine how the composite address field is labeled and used within the module layout. Maximum length: 25

Get layouts metadata — response body — layouts layouts item sections item fields item allowed permissions to update

Field	Type	Presence	Description and constraints
$	object	Root	Represents the set of permission levels that can be actively assigned to this field across profiles, indicating which visibility and access states are eligible for modification. Returned only when the query parameter `include_inner_details=fields.allowed_permissions_to_update` is specified in the request. Additional keys: not allowed
hidden	boolean	Required within parent	Indicates whether the hidden permission level is eligible to be assigned to this field. Possible values: `true` — the field's visibility can be set to hidden for specific profiles, concealing it entirely from their layout view; `false` — the hidden permission cannot be applied to this field.
read_only	boolean	Required within parent	Indicates whether the read-only permission level is eligible to be assigned to this field. Possible values: `true` — the field can be configured as read-only for specific profiles, allowing users to view but not edit its value; `false` — the read-only permission cannot be applied to this field.
read_write	boolean	Required within parent	Indicates whether the read-write permission level is eligible to be assigned to this field. Possible values: `true` — the field can be configured for full read and write access for specific profiles, permitting both viewing and editing; `false` — the read-write permission cannot be applied to this field.

Get layouts metadata — response body — layouts layouts item sections item fields item associated module id, layout, module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the associated module details when this field is a subform field, including the module API name and the layout used to render the embedded records. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the associated module Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
layout	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item associated module id, layout, module layout
module	string	Required within parent	Represents the API name of a CRM module, used as a programmatic identifier in API requests, automation configurations, and cross-module references. API name of the associated module Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item associated module id, layout, module layout

Get layouts metadata — response body — layouts layouts item sections item fields item associated module id, layout, module layout

Field	Type	Presence	Description and constraints
$	object	Root	Represents the name of the layout applied to the associated module's records when displayed within the subform field, determining which set of fields and sections are rendered in the embedded view. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the layout Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the name of the layout applied to the associated module's records when displayed within the subform field, determining which set of fields and sections are rendered in the embedded view. Maximum length: 100 Minimum length: 1

Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup association details when this field is connected to another module through a lookup relationship, including the lookup and related field metadata. Additional keys: not allowed
lookup_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field lookup field
related_field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field related field

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field lookup field, Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field related field

Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the lookup field on the source module that establishes the association, containing identifying metadata such as the field's API name and display label. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the lookup field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the lookup field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item association details lookup field, related field related field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the corresponding field on the related module that is linked through the association, containing identifying metadata such as the field's API name and display label. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the related field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the related field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item child fields array item field

Field	Type	Presence	Description and constraints
$	object	Root	Contains the identifying attributes of the child field, such as its API name, used to reference the corresponding FieldSchema within the module layout. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the child field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the child field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the API name of the child field, used to uniquely identify it within the parent composite field and reference it in layout and data operations. Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Accounts, Contacts, Deals

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Leads module field conversion mapping, specifying the destination field API names in the Contacts, Deals, and Accounts modules for this field during lead conversion. Additional keys: not allowed
Accounts	JSON	Required within parent	Represents the API name of the destination field in the **Accounts** module to which this field's value is mapped during record conversion, or null when no mapping to Accounts is defined.
Accounts (anyOf 1)	string	Alternative	Represents the API name of the target field in the **Accounts** module for this field's value during lead-to-Accounts conversion. Maximum length: 100
Accounts (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
Contacts	JSON	Required within parent	Represents the API name of the destination field in the **Contacts** module to which this field's value is mapped during record conversion, or null when no mapping to Contacts is defined.
Contacts (anyOf 1)	string	Alternative	Represents the API name of the target field in the **Contacts** module for this field's value during lead-to-Contacts conversion. Maximum length: 100
Contacts (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
Deals	JSON	Required within parent	Represents the API name of the destination field in the **Deals** module to which this field's value is mapped during record conversion, or null when no mapping to Deals is defined.
Deals (anyOf 1)	string	Alternative	Represents the API name of the target field in the **Deals** module for this field's value during lead-to-Deals conversion. Maximum length: 100
Deals (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Invoices

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Sales Orders module field conversion mapping, specifying the destination field API name in the Invoices module for this field during Sales Order conversion. Maximum fields: 1 Minimum fields: 1 Additional keys: not allowed
Invoices	JSON	Required within parent	Represents the API name of the destination field in the **Invoices** module to which this field's value is mapped under an alternate conversion schema variant, or null when no mapping to Invoices is defined in this context.
Invoices (anyOf 1)	string	Alternative	Represents the API name of the target field in the **Invoices** module for this field's value during Sales Order-to-Invoices conversion. Maximum length: 100
Invoices (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Get layouts metadata — response body — layouts layouts item sections item fields item convert mapping Invoices, Sales Orders

Field	Type	Presence	Description and constraints
$	object	Root	Represents the Quotes module field conversion mapping, specifying the destination field API names in the Invoices and Sales_Orders modules for this field during quote conversion. Additional keys: not allowed
Invoices	JSON	Required within parent	Represents the API name of the destination field in the **Invoices** module to which this field's value is mapped during record conversion, or null when no mapping to Invoices is defined.
Invoices (anyOf 1)	string	Alternative	Represents the API name of the target field in the **Invoices** module for this field's value during quote-to-Invoices conversion. Maximum length: 100
Invoices (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
Sales_Orders	JSON	Required within parent	Represents the API name of the destination field in the **Sales_Orders** module to which this field's value is mapped during record conversion, or null when no mapping to Sales Orders is defined.
Sales_Orders (anyOf 1)	string	Alternative	Represents the API name of the target field in the **Sales_Orders** module for this field's value during quote-to-Sales_Orders conversion. Maximum length: 100
Sales_Orders (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Get layouts metadata — response body — layouts layouts item sections item fields item file upolad optionlist array item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single permitted file source entry, identifying an upload channel such as local device storage, cloud drive, or URL by its display label and internal value. Additional keys: not allowed
actual_value	string	Required within parent	Represents the system-level identifier for the file upload source, used internally to route the upload request to the correct provider. Maximum length: 100
display_value	string	Required within parent	Represents the label shown in the CRM interface for the file upload source option, communicating the upload channel name to the end user. Maximum length: 100

Get layouts metadata — response body — layouts layouts item sections item fields item global map dependency id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active global map dependency configuration linking this field to a shared organizational mapping definition. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the global map dependency. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item global picklist api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active global picklist configuration linking this field to a shared organization-level picklist definition. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the global picklist Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the global picklist Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item hipaa compliance restricted, restricted in export

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active HIPAA compliance configuration for this field, specifying the access restriction and export suppression settings applied when HIPAA compliance is enabled. Additional keys: not allowed
restricted	boolean	Required within parent	Indicates whether access to this field's value is restricted under HIPAA compliance rules, limiting visibility to only those users or roles authorized to handle protected health information. Possible values: `true` — the field is treated as restricted PHI and access controls are enforced; `false` — the field is not subject to HIPAA access restrictions.
restricted_in_export	boolean	Required within parent	Indicates whether this field's value is suppressed or masked when records are exported, in accordance with HIPAA data handling requirements. Possible values: `true` — the field is excluded or redacted in exported data sets; `false` — the field value is included in exports without HIPAA-based redaction.

Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active history tracking configuration for this field, detailing the retention duration, tracked fields, associated module, and related list configuration. Additional keys: not allowed
duration_configuration	string	Optional	Contains the settings that govern the time window over which field value changes are retained in the history log, such as the retention period length and applicable time units used to define how far back historical data is preserved. Maximum length: 120
duration_configured_field	JSON	Optional
duration_configured_field (anyOf 1)	Model	Alternative	Expand Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name duration configured field api name, id
duration_configured_field (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.
followed_fields	array	Optional	Contains the collection of fields whose value changes are actively monitored and recorded as part of this field's history tracking configuration, allowing administrators to scope audit trail capture to a defined subset of related fields. Maximum items: 100
followed_fields[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name followed fields item
module	Model	Optional	Expand Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name module
related_list_name	string	Optional	Represents the display name of the related list through which the field's historical change records are surfaced on the associated module's detail view, allowing end users to review the audit trail directly within the record context. Maximum length: 100

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name duration configured field api name, id, Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name followed fields item, Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name module

Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name duration configured field api name, id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active configuration of the field designated to supply the retention duration value for history tracking. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the duration field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the duration field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name followed fields item

Field	Type	Presence	Description and constraints
$	object	Root	Represents an individual field entry being tracked for history, including its identifying metadata and the module context in which changes to that field are captured for the audit log. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the followed field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the followed field Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item history tracking duration configuration, duration configured field, followed fields, module, related list name module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the CRM module with which this field's history tracking is associated, providing the module-level context required to correctly scope, store, and surface field change records in the appropriate audit trail. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the history tracking module Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the history tracking module Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the target CRM module that this lookup field references, providing the module's identifying metadata — such as its name and encryption status — required to resolve and navigate the cross-module relationship. Additional keys: not allowed
api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the lookup module Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
crypt	boolean	Optional	Indicates whether data stored in the lookup's target module is encrypted at rest, informing consumers that records retrieved through this lookup relationship may be subject to field-level encryption policies. Possible values: `true` — the target module's data is encrypted; `false` — the target module's data is not encrypted.
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the lookup module Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit query details criteria, query id, system query id criteria field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the field used as the left-hand operand in the lookup filter criterion, identifying which field's value is evaluated against the specified comparator and value. Additional keys: not allowed
api_name	string	Optional	Represents the API name of the field used in the lookup filter criterion, which may reference a standard field, a custom field, or a related field accessed through dot notation. Maximum length: 100
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the field used in the criteria. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item lookup api name, display label, id, module, query details, revalidate filter during edit query details system query id

Field	Type	Presence	Description and constraints
$	object	Root	Represents the query configuration variant that contains only a system query identifier, without custom filter criteria, used when the lookup filter logic is entirely managed by the CRM platform. Additional keys: not allowed
system_query_id	JSON	Required within parent	Represents the system-assigned identifier for an alternate platform-managed query variant that filters the lookup's record list in this configuration schema variant.
system_query_id (anyOf 1)	string	Alternative	Represents the system-assigned query identifier as a string in the system-query-only variant, referencing a platform-managed filter for the lookup. Format: int64 Maximum length: 30
system_query_id (anyOf 2)	null	Alternative	Represents a null value used in `oneOf` schemas where a property may be absent or explicitly set to null.

Get layouts metadata — response body — layouts layouts item sections item fields item lookup field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the source lookup field on which a mirror field is based, identifying the cross-module lookup relationship from which this field's value is derived. Additional keys: not allowed
api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Optional	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles

Field	Type	Presence	Description and constraints
$	object	Root	Represents the complete masking configuration where the entire field value is hidden from users who do not have an exempted profile. Additional keys: not allowed
complete_mask	boolean	Required within parent	Indicates whether the entire field value is hidden in this alternate masking schema variant. Possible values: `true` — the value is completely obscured; `false` — partial reveal rules apply.
profiles	array	Required within parent	Contains the list of CRM profiles whose members can view the unmasked field value in this alternate masking schema variant, exempting those users from the masking rules applied to all other profiles. Maximum items: 50
profiles[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles profiles item

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles profiles item

Get layouts metadata — response body — layouts layouts item sections item fields item mask details complete mask, profiles profiles item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a CRM profile that is permitted to view the unmasked value of a masked field, exempting users of this profile from the field's masking rules. Additional keys: not allowed
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the profile. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
name	string	Required within parent	Represents the name of the CRM profile that is permitted to view the unmasked field value, identifying which user group is exempt from the field's masking rules. Maximum length: 60

Get layouts metadata — response body — layouts layouts item sections item fields item multi module lookup api name, display label, dynamic module addition allowed, modules

Field	Type	Presence	Description and constraints
$	object	Root	Represents the active multi-module lookup configuration, specifying the participating modules, display label, and dynamic addition settings. Additional keys: not allowed
api_name	string	Optional	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the multi module lookup field Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
display_label	string	Optional	Represents the identifying label of the multi-module lookup field in the CRM interface, identifying the lookup relationship across its participating modules. Maximum length: 50
dynamic_module_addition_allowed	boolean	Optional	Indicates whether additional CRM modules can be incorporated into this multi-module lookup relationship at runtime without requiring a layout reconfiguration. Possible values: `true` — new modules may be added dynamically; `false` — the participating modules are fixed at configuration time.
modules	array	Optional	Contains the collection of CRM modules that participate in this multi-module lookup relationship, each representing a valid source from which the user can select a referenced record. Maximum items: 100
modules[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multi module lookup api name, display label, dynamic module addition allowed, modules modules item

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item multi module lookup api name, display label, dynamic module addition allowed, modules modules item

Get layouts metadata — response body — layouts layouts item sections item fields item multi module lookup api name, display label, dynamic module addition allowed, modules modules item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single module entry included in the multi-module lookup configuration, encapsulating identifying and display attributes for that module. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. API name of the module Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Unique identifier of the module Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
module_name	string	Required within parent	Indicates the internal API name of the module participating in the multi-module lookup, used to identify the module programmatically across CRM operations. Maximum length: 50

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details

Field	Type	Presence	Description and constraints
$	object	Root	Contains metadata about the target module and its associated layouts and fields that the multi-select lookup field resolves records against. Additional keys: not allowed
field	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details field
layouts	array	Required within parent	Contains the collection of layouts within the connected module in which the multi-select lookup field is available or rendered. Maximum items: 100
layouts[]	Model	Each item	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details layouts item
module	Model	Required within parent	Expand Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details module

Referenced models: Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details field, Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details layouts item, Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details module

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details field

Field	Type	Presence	Description and constraints
$	object	Root	Represents the specific field in the connected module that is referenced by the multi-select lookup, used to surface a meaningful value from the related record. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
field_label	string	Required within parent	Contains the display label of the referenced field in the connected module, as shown to users when viewing or configuring the multi-select lookup. Maximum length: 100
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details layouts item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single layout entry from the connected module, identifying a page layout in which the multi-select lookup field participates. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$

Get layouts metadata — response body — layouts layouts item sections item fields item multiselectlookup connected details, linking details, related list connected details module

Field	Type	Presence	Description and constraints
$	object	Root	Represents the target module to which the multi-select lookup field resolves, providing display and identification attributes for that module. Additional keys: not allowed
api_name	string	Required within parent	Represents an API identifier string composed of alphanumeric characters and underscores, used as a programmatic reference for fields, modules, and other CRM entities. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$
id	string	Required within parent	Represents a unique numeric identifier for a CRM entity, expressed as a 64-bit integer serialized as a string to preserve precision in JSON. Format: int64 Maximum length: 19 Minimum length: 1 Pattern: ^[0-9]{1,19}$
plural_label	string	Required within parent	Contains the plural display name of the connected module, typically shown in list views and relationship panels referencing multiple records. Maximum length: 100