Zoho: Related lists schemas
17 Zoho schemas with complete fields and constraints.
← Related lists operations · All schemas
Related Lists — response body — related lists related lists item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the base configuration metadata for a related list panel in a CRM module. |
$ (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup |
$ (anyOf 2) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration metadata for a standard (non-multiselectlookup) related list. Additional keys: not allowed |
_layout_specific_properties | JSON | Optional | |
_layout_specific_properties (anyOf 1) | array | Alternative | Layout-specific configuration overrides for this related list. Maximum items: 25 Minimum items: 0 |
_layout_specific_properties (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item |
_layout_specific_properties (anyOf 2) | null | Alternative | Layout-specific configuration overrides for this related list. Maximum items: 25 Minimum items: 0 |
_layout_specific_properties (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item |
action | JSON | Required within parent | |
action (anyOf 1) | string | Alternative | Action type supported for adding records to the related list. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
action (anyOf 2) | null | Alternative | Action type supported for adding records to the related list. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
api_name | string | Required within parent | API name identifier for the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedlookupApiName | string | Optional | API name of the connected lookup field for this related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedmodule | JSON | Optional | |
connectedmodule (anyOf 1) | string | Alternative | API name of the connected module for this lookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedmodule (anyOf 2) | null | Alternative | API name of the connected module for this lookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
customize_display_label | boolean | Required within parent | Indicates whether the display label of this related list can be customized. Possible values: **true**, **false**. |
customize_fields | boolean | Required within parent | Indicates whether the field selection for this related list can be customized. Possible values: **true**, **false**. |
customize_sort | boolean | Required within parent | Indicates whether the sort configuration for this related list can be customized. Possible values: **true**, **false**. |
display_label | string | Required within parent | User-visible label displayed for the related list panel. Maximum length: 50 Minimum length: 1 |
fields | JSON | Optional | |
fields (anyOf 1) | array | Alternative | Fields displayed in the related list (null if not configured). Maximum items: 50 Minimum items: 0 |
fields (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item |
fields (anyOf 2) | null | Alternative | Fields displayed in the related list (null if not configured). Maximum items: 50 Minimum items: 0 |
fields (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item |
href | JSON | Required within parent | |
href (anyOf 1) | string | Alternative | Relative URL template for navigating to the related list records. Maximum length: 200 Minimum length: 1 |
href (anyOf 2) | null | Alternative | Relative URL template for navigating to the related list records. Maximum length: 200 Minimum length: 1 |
id | string | Required within parent | Unique identifier of the related list configuration. Format: int64 |
linkingmodule | JSON | Optional | |
linkingmodule (anyOf 1) | string | Alternative | API name of the linking module for this relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
linkingmodule (anyOf 2) | null | Alternative | API name of the linking module for this relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
module | JSON | Required within parent | Module information for the related list. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for details. |
module (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label |
module (anyOf 2) | null | Alternative | Represents the null state when no module is associated with this related list. |
name | string | Required within parent | Internal name of the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_ \-]+$ |
parent_related_lists | JSON | Optional | |
parent_related_lists (anyOf 1) | array | Alternative | List of parent related list references that this related list depends on. Maximum items: 4 Minimum items: 0 |
parent_related_lists (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item |
parent_related_lists (anyOf 2) | null | Alternative | List of parent related list references that this related list depends on. Maximum items: 4 Minimum items: 0 |
parent_related_lists (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item |
personality_name | string | Optional | Internal personality identifier associated with this related list configuration. Maximum length: 100 Minimum length: 1 |
record_operations | Model | Optional | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations |
sequence_number | string | Required within parent | Display sequence position of the related list in the layout. Format: int32 |
sort_by | JSON | Optional | Field used for sorting the related list (null if no sorting configured). |
sort_by (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion sort by api name, id |
sort_by (anyOf 2) | null | Alternative | No sorting is applied. |
sort_order | JSON | Optional | |
sort_order (anyOf 1) | string | Alternative | Sort direction applied to the related list (null if no sorting configured). Known values: asc, desc |
sort_order (anyOf 2) | null | Alternative | Sort direction applied to the related list (null if no sorting configured). Known values: asc, desc |
status | string | Required within parent | Visibility status of the related list. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. Known values: visible, user_hidden, scheduled_for_deletion |
type | string | Required within parent | Relationship type of the related list. Known values: default, custom, custom_lookup, custom_related_list, queries, grouped, combined_view, slyteui |
visibility | JSON | Optional | |
visibility (anyOf 1) | integer | Alternative | Numeric visibility flag for the related list. Format: int32 Minimum: 0 |
visibility (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion sort by api name, id
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field configured as a column in a related list view. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field. Maximum length: 100 Minimum length: 1 Pattern: ^!?[A-Za-z0-9_.]+$ |
decimal_place | JSON | Optional | |
decimal_place (anyOf 1) | JSON | Alternative | |
decimal_place (anyOf 1) (anyOf 1) | integer | Alternative | Number of decimal places configured for numeric fields. Format: int32 |
decimal_place (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
decimal_place (anyOf 2) | null | Alternative | Number of decimal places configured for numeric fields. Format: int32 |
enable_colour_code | boolean | Optional | Indicates whether color coding is enabled for this field. Possible values: **true**, **false**. |
field_label | string | Optional | Display label of the field. Maximum length: 100 Minimum length: 1 |
formula | object | Optional | Formula configuration for the field. Empty object if the field is not a formula field. Returned when include_inner_details contains fields.formula. Additional keys: not allowed |
formula.return_type | string | Optional | The return type of the formula (e.g., text, number). Maximum length: 50 |
id | string | Required within parent | Unique identifier of the field. Format: int64 |
lookup | object | Optional | Lookup configuration for the field. Empty object if the field is not a lookup. Returned when include_inner_details contains fields.lookup. Additional keys: not allowed |
lookup.api_name | string | Optional | API name of the lookup related list. Maximum length: 100 |
lookup.display_label | string | Optional | Display label of the lookup related list. Maximum length: 50 |
lookup.id | string | Optional | Unique identifier of the lookup field. Format: int64 |
lookup.module | object | Optional | Module details for the lookup field. Additional keys: not allowed |
lookup.module.api_name | string | Required within parent | API name of the lookup target module. Maximum length: 100 |
lookup.module.id | string | Required within parent | Unique identifier of the lookup target module. Format: int64 |
lookup.query_details | object | Optional | Query details for the lookup field. Additional keys: not allowed |
lookup.query_details.system_query_id | JSON | Required within parent | |
lookup.query_details.system_query_id (anyOf 1) | string | Alternative | System query ID for the lookup field. Format: int64 |
lookup.query_details.system_query_id (anyOf 2) | null | Alternative | System query ID for the lookup field. Format: int64 |
lookup.revalidate_filter_during_edit | boolean | Optional | Indicates if the filter should be revalidated during edit. |
mask_details | object | Optional | Masking configuration for the field. Returned when include_inner_details contains fields.mask_details. Additional keys: not allowed |
pick_list_values | array | Optional | List of picklist values for picklist-type fields in the related list. Maximum items: 500 |
pick_list_values[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item pick list values item |
refer_from_field | object | Optional | Reference field configuration. Returned when include_inner_details contains fields.refer_from_field. Additional keys: not allowed |
rollup_summary | object | Optional | Rollup summary configuration for the field. Empty object if the field is not a rollup summary. Returned when include_inner_details contains fields.rollup_summary. Additional keys: not allowed |
rollup_summary.return_type | string | Optional | The return type of the rollup summary (e.g., integer, number). Maximum length: 50 |
separator | boolean | Optional | Indicates whether a separator is displayed after this field. Possible values: **true**, **false**. |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Display order position of the field within the related list. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
ui_type | JSON | Optional | |
ui_type (anyOf 1) | integer | Alternative | UI type identifier that determines how the field is rendered. Format: int32 |
ui_type (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item pick list values item
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item pick list values item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a single picklist option, including its display value, stored value, and visual configuration. Additional keys: not allowed |
actual_value | string | Required within parent | Stored value for this picklist option. Maximum length: 255 |
colour_code | JSON | Required within parent | |
colour_code (anyOf 1) | string | Alternative | Color code assigned to this picklist value for visual representation. Maximum length: 7 |
colour_code (anyOf 2) | null | Alternative | Color code assigned to this picklist value for visual representation. Maximum length: 7 |
display_value | string | Required within parent | Display value shown to the user in the picklist. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the picklist value. Format: int64 |
reference_value | string | Required within parent | Internal reference value associated with this picklist option. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Display sequence position of this picklist value. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
type | string | Required within parent | Type classification of the picklist value. Known values: used, unused |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents layout-specific configuration overrides for a related list, including per-layout sequence and visibility. Additional keys: not allowed |
layout | object | Required within parent | Layout information for which this property override applies. Additional keys: not allowed |
layout.id | string | Required within parent | Unique identifier of the layout. Format: int64 |
layout.name | string | Required within parent | Display name of the layout. Maximum length: 100 Minimum length: 1 |
sequence_number | string | Required within parent | Display sequence position of this related list in the specified layout. Format: int32 |
status | string | Required within parent | Visibility status of the related list in the specified layout. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. Known values: visible, user_hidden, scheduled_for_deletion |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the module associated with a related list, including its API name and unique identifier. Additional keys: not allowed |
api_name | string | Required within parent | API name of the module associated with the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
id | string | Required within parent | Unique identifier of the module. Format: int64 |
plural_label | string | Optional | Plural display label of the module. Maximum length: 250 Minimum length: 1 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a reference to a parent related list that this related list depends on for contextual display. Additional keys: not allowed |
api_name | string | Required within parent | API name of the parent related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
id | string | Required within parent | Unique identifier of the parent related list. Format: int64 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the set of record operations permitted for a related list. Additional keys: not allowed |
assign | boolean | Required within parent | Indicates whether the assign operation is allowed on records in the related list. Possible values: **true**, **false**. |
bulk_edit | boolean | Required within parent | Indicates whether the bulk edit operation is allowed on records in the related list. Possible values: **true**, **false**. |
create | boolean | Required within parent | Indicates whether the create operation is allowed on records in the related list. Possible values: **true**, **false**. |
delete | boolean | Required within parent | Indicates whether the delete operation is allowed on records in the related list. Possible values: **true**, **false**. |
disassociate | boolean | Required within parent | Indicates whether records can be disassociated from the related list. Possible values: **true**, **false**. |
edit | boolean | Required within parent | Indicates whether the edit operation is allowed on records in the related list. Possible values: **true**, **false**. |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion sort by api name, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the field used to sort records in a related list. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field used for sorting. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
id | string | Required within parent | Unique identifier of the field used for sorting. Format: int64 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration metadata for a related list of type multiselectlookup. Additional keys: not allowed |
_layout_specific_properties | JSON | Optional | |
_layout_specific_properties (anyOf 1) | array | Alternative | Layout-specific configuration overrides for this related list, such as per-layout sequence and visibility. Maximum items: 25 Minimum items: 0 |
_layout_specific_properties (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item |
_layout_specific_properties (anyOf 2) | null | Alternative | Layout-specific configuration overrides for this related list, such as per-layout sequence and visibility. Maximum items: 25 Minimum items: 0 |
_layout_specific_properties (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item |
action | JSON | Required within parent | |
action (anyOf 1) | string | Alternative | Action type supported for adding records to the related list. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
action (anyOf 2) | null | Alternative | Action type supported for adding records to the related list. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
api_name | string | Required within parent | API name identifier for the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedlookupApiName | string | Optional | API name of the connected lookup field for this multiselectlookup related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedmodule | JSON | Optional | |
connectedmodule (anyOf 1) | string | Alternative | API name of the connected module for this multiselectlookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedmodule (anyOf 2) | null | Alternative | API name of the connected module for this multiselectlookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
customize_display_label | boolean | Required within parent | Indicates whether the display label of this related list can be customized. Possible values: **true**, **false**. |
customize_fields | boolean | Required within parent | Indicates whether the field selection for this related list can be customized. Possible values: **true**, **false**. |
customize_sort | boolean | Required within parent | Indicates whether the sort configuration for this related list can be customized. Possible values: **true**, **false**. |
display_label | string | Required within parent | User-visible label displayed for the related list panel. Maximum length: 50 Minimum length: 1 |
field_enabled | boolean | Optional | Indicates whether the multiselectlookup field is enabled. Possible values: **true**, **false**. |
fields | JSON | Optional | |
fields (anyOf 1) | array | Alternative | List of fields configured as columns in the related list view. Maximum items: 50 Minimum items: 0 |
fields (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item |
fields (anyOf 2) | null | Alternative | List of fields configured as columns in the related list view. Maximum items: 50 Minimum items: 0 |
fields (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item |
href | JSON | Required within parent | |
href (anyOf 1) | string | Alternative | Relative URL template for navigating to the related list records. Maximum length: 200 Minimum length: 1 |
href (anyOf 2) | null | Alternative | Relative URL template for navigating to the related list records. Maximum length: 200 Minimum length: 1 |
id | string | Required within parent | Specifies the unique identifier of the related list configuration. Format: int64 |
linkingmodule | JSON | Optional | |
linkingmodule (anyOf 1) | string | Alternative | API name of the linking module that connects the two entities in the multiselectlookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
linkingmodule (anyOf 2) | null | Alternative | API name of the linking module that connects the two entities in the multiselectlookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
module | JSON | Required within parent | Module information for the related list. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for details. |
module (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label |
module (anyOf 2) | null | Alternative | Represents the null state when no module is associated with this related list. |
multiselectlookup | Model | Optional | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup |
name | string | Required within parent | Internal name of the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_ \-]+$ |
parent_related_lists | JSON | Optional | |
parent_related_lists (anyOf 1) | array | Alternative | List of parent related list references that this related list depends on for contextual display. Maximum items: 4 Minimum items: 0 |
parent_related_lists (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item |
parent_related_lists (anyOf 2) | null | Alternative | List of parent related list references that this related list depends on for contextual display. Maximum items: 4 Minimum items: 0 |
parent_related_lists (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item |
personality_name | string | Optional | Internal personality identifier associated with this related list configuration. Maximum length: 100 Minimum length: 1 |
record_operations | Model | Optional | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations |
sequence_number | string | Required within parent | Specifies the display sequence position of the related list in the layout. Format: int32 |
sort_by | JSON | Optional | Field by which records in this related list are sorted. |
sort_by (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup sort by api name, id |
sort_by (anyOf 2) | null | Alternative | Represents the null state when no sort field is configured for this related list. |
sort_order | JSON | Optional | |
sort_order (anyOf 1) | string | Alternative | Sort direction for records in this related list. Possible values: **asc**, **desc**. Known values: asc, desc |
sort_order (anyOf 2) | null | Alternative | Sort direction for records in this related list. Possible values: **asc**, **desc**. Known values: asc, desc |
status | string | Required within parent | Visibility status of the related list. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. Known values: visible, user_hidden, scheduled_for_deletion |
type | string | Required within parent | Relationship type of the related list. Known values: multiselectlookup |
visibility | JSON | Optional | |
visibility (anyOf 1) | integer | Alternative | Numeric visibility flag for the related list. Format: int32 Minimum: 0 |
visibility (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup sort by api name, id, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the multiselectlookup configuration for a related list, including the lookup field, linking module, and connected module details. Additional keys: not allowed |
connected_details | Model | Required within parent | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details |
field | object | Required within parent | Lookup field configuration for the multiselectlookup relationship. Additional keys: not allowed |
field.api_name | string | Required within parent | API name of the lookup field. Maximum length: 100 |
field.field_label | string | Required within parent | Display label of the lookup field. Maximum length: 100 |
field.id | string | Required within parent | Unique identifier of the lookup field. Format: int64 |
field_enabled | boolean | Required within parent | Indicates whether the multiselectlookup field is enabled. Possible values: **true**, **false**. |
linking_details | object | Required within parent | Details of the linking module that connects the two entities in the multiselectlookup. Additional keys: not allowed |
linking_details.connected_lookup_field | object | Required within parent | Lookup field in the linking module that references the connected module. Additional keys: not allowed |
linking_details.connected_lookup_field.api_name | string | Required within parent | API name of the connected lookup field in the linking module. Maximum length: 100 |
linking_details.connected_lookup_field.id | string | Required within parent | Unique identifier of the connected lookup field in the linking module. Format: int64 |
linking_details.lookup_field | object | Required within parent | Lookup field in the linking module that references the source module. Additional keys: not allowed |
linking_details.lookup_field.api_name | string | Required within parent | API name of the lookup field in the linking module that references the source module. Maximum length: 100 |
linking_details.lookup_field.id | string | Required within parent | Unique identifier of the lookup field in the linking module. Format: int64 |
linking_details.module | Model | Required within parent | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup linking details module |
linking_details.visibility | JSON | Required within parent | |
linking_details.visibility (anyOf 1) | integer | Alternative | Visibility flag for the linking module relationship. Format: int32 |
linking_details.visibility (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup linking details module
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the connected module and field in the multiselectlookup relationship. Additional keys: not allowed |
field | Model | Required within parent | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details field |
module | Model | Required within parent | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details module |
related_list | Model | Required within parent | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details related list |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details field, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details module, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details related list
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field configuration in the connected module for the multiselectlookup relationship. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field in the connected module. Maximum length: 100 |
field_label | string | Required within parent | Display label of the field in the connected module. Maximum length: 100 |
id | string | Required within parent | Unique identifier of the field in the connected module. Format: int64 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Connected module information in the multiselectlookup relationship. Additional keys: not allowed |
api_name | string | Required within parent | API name of the connected module. Maximum length: 100 |
id | string | Required within parent | Unique identifier of the connected module. Format: int64 |
plural_label | string | Required within parent | Plural display label of the connected module. Maximum length: 100 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup connected details related list
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Related list information in the connected module. Additional keys: not allowed |
api_name | string | Required within parent | API name of the related list in the connected module. Maximum length: 100 |
display_label | string | Required within parent | Display label of the related list in the connected module. Maximum length: 50 |
id | string | Required within parent | Unique identifier of the related list in the connected module. Format: int64 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup multiselectlookup linking details module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Linking module information for the multiselectlookup relationship. Additional keys: not allowed |
api_name | string | Required within parent | API name of the linking module. Maximum length: 100 |
id | string | Required within parent | Unique identifier of the linking module. Format: int64 |
plural_label | string | Required within parent | Plural display label of the linking module. Maximum length: 100 |
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup sort by api name, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Field metadata used for sorting a multiselectlookup related list. The api_name follows the format ModuleName.FieldApiName (e.g., "Leads.Company") where the left part is the connected module api_name and the right part is the field api_name. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field used for sorting. For multiselectlookup related lists, this is in the format ModuleName.FieldApiName (e.g., "Leads.Company"). Maximum length: 200 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+(\.[A-Za-z0-9_]+)?$ |
id | string | Required within parent | Unique identifier of the sort field. Format: int64 |