Zoho: Get module metadata by API name

← Modules operations · Get started

Operation zoho.getmodulebyapiname

Provider route: GET /crm/v8/settings/modules/{moduleIdentifier}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["modules"]["getModuleByApiName"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.modules.getModuleByApiName(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.modules.get_module_by_api_name(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	Model	Required within parent	Expand Get module metadata by API name — request body — path
query	object	Optional	Additional keys: not allowed
query.fields	array	Optional	Maximum items: 100
query.fields[]	string	Each item	Specifies the properties to include in the response Maximum length: 255
query.include_inner_details	string	Optional	Maximum length: 512

Referenced models: Get module metadata by API name — request body — path

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	object	Alternative	Complete configuration metadata for a single CRM module, including its fields, layouts, profiles, related lists, and supported capabilities Additional keys: not allowed
$ (anyOf 1).modules	array	Required within parent	Array of module metadata objects returned for the specified API name. Contains at most one element, as each API name maps to a single module. Maximum items: 1
$ (anyOf 1).modules[]	object	Each item	Complete metadata for a CRM module including configuration, capabilities, fields, layouts, profiles, and related lists. Additional keys: not allowed
$ (anyOf 1).modules[].$field_states	JSON	Optional
$ (anyOf 1).modules[].$field_states (anyOf 1)	array	Alternative	Nullable array of field-state identifiers (up to 1 entry, max 20 characters each) that govern dynamic field visibility and validation rules within this module. Maximum items: 1
$ (anyOf 1).modules[].$field_states (anyOf 1)[]	string	Each item	Field state identifier Maximum length: 20
$ (anyOf 1).modules[].$field_states (anyOf 2)	null	Alternative	Nullable array of field-state identifiers (up to 1 entry, max 20 characters each) that govern dynamic field visibility and validation rules within this module. Maximum items: 1
$ (anyOf 1).modules[].$field_states (anyOf 2)[]	string	Each item	Field state identifier Maximum length: 20
$ (anyOf 1).modules[].$on_demand_properties	JSON	Optional
$ (anyOf 1).modules[].$on_demand_properties (anyOf 1)	array	Alternative	Nullable array of string identifiers (up to 100, max 50 chars each) for module properties that are loaded on-demand rather than included in the default response. Maximum items: 100
$ (anyOf 1).modules[].$on_demand_properties (anyOf 1)[]	string	Each item	Name of an on-demand property that can be requested explicitly. Maximum length: 50
$ (anyOf 1).modules[].$on_demand_properties (anyOf 2)	null	Alternative	Nullable array of string identifiers (up to 100, max 50 chars each) for module properties that are loaded on-demand rather than included in the default response. Maximum items: 100
$ (anyOf 1).modules[].$on_demand_properties (anyOf 2)[]	string	Each item	Name of an on-demand property that can be requested explicitly. Maximum length: 50
$ (anyOf 1).modules[].$others_awaiting	boolean	Optional	True when other users are awaiting action on records in this module. Exposed only for the Approvals module.
$ (anyOf 1).modules[].$properties	JSON	Optional
$ (anyOf 1).modules[].$properties (anyOf 1)	array	Alternative	Nullable array of extended property objects (up to 50) representing additional module capabilities; each item is either a string property name or an object with arbitrary key-value pairs. Maximum items: 50
$ (anyOf 1).modules[].$properties (anyOf 1)[]	JSON	Each item	Represents a module capability or property flag name.
$ (anyOf 1).modules[].$properties (anyOf 1)[] (anyOf 1)	string	Alternative	Property name identifier Maximum length: 50
$ (anyOf 1).modules[].$properties (anyOf 1)[] (anyOf 2)	object	Alternative	Extended property object containing additional module metadata Additional keys: allowed
$ (anyOf 1).modules[].$properties (anyOf 2)	null	Alternative	Nullable array of extended property objects (up to 50) representing additional module capabilities; each item is either a string property name or an object with arbitrary key-value pairs. Maximum items: 50
$ (anyOf 1).modules[].$properties (anyOf 2)[]	JSON	Each item	Represents a module capability or property flag name.
$ (anyOf 1).modules[].$properties (anyOf 2)[] (anyOf 1)	string	Alternative	Property name identifier Maximum length: 50
$ (anyOf 1).modules[].$properties (anyOf 2)[] (anyOf 2)	object	Alternative	Extended property object containing additional module metadata Additional keys: allowed
$ (anyOf 1).modules[].access_type	string	Optional	Access control scope for the module. Possible values: org_based - organization-wide access; team_based - team-specific access. Immutable after module creation; cannot be changed via PUT. Known values: org_based, team_based
$ (anyOf 1).modules[].activity_badge	string	Optional	Activity badge status for the module. Possible values: Enabled - badge is active; Not_Supported - module does not support activity badges; Disabled - badge is inactive. Known values: Enabled, Not_Supported, Disabled
$ (anyOf 1).modules[].actual_plural_label	string	Optional	System-level plural label for the module as stored in the database, representing the untranslated base value. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].actual_singular_label	string	Optional	System-level singular label for the module as stored in the database, representing the untranslated base value. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].api_name	string	Optional	Case-sensitive API name used to reference this module in API requests (e.g., ‘Leads’, ‘Contacts’, ‘CustomModule1’). Maximum length: 50
$ (anyOf 1).modules[].api_supported	boolean	Optional	True when the module is accessible via the Zoho CRM API; false for modules that are not externally queryable through API endpoints.
$ (anyOf 1).modules[].arguments	array	Optional	Array of argument objects (up to 10) used to substitute dynamic parameters in web tab URLs (e.g., https://…&id=${Users.User Id}&name=${Users.First Name}). Duplicates are allowed and order is preserved for multi-occurrence parameters; empty for non-web-tab modules. Maximum items: 10 Unique items: false
$ (anyOf 1).modules[].arguments[]	object	Each item	Argument object containing name-value pair for URL parameter substitution Additional keys: not allowed
$ (anyOf 1).modules[].arguments[].name	string	Required within parent	Key name of the URL argument used as a placeholder in the web tab URL template. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].arguments[].value	string	Required within parent	Field substitution reference expression resolving to a CRM field value at runtime (e.g., users.recordId). Maximum 100 characters. Maximum length: 100
$ (anyOf 1).modules[].business_card_field_limit	JSON	Optional
$ (anyOf 1).modules[].business_card_field_limit (anyOf 1)	integer	Alternative	Maximum number of fields allowed in the business card view for this module. Non-negative integer; 0 means no fields are configured. Format: int32 Minimum: 0
$ (anyOf 1).modules[].business_card_field_limit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].business_card_fields	array	Optional	Fields displayed in the business card view (up to 15). Present only when ‘business_card_fields’ is included in the include parameter. Can be empty array, array of objects with api_name and id, or array of string API names. Maximum items: 15
$ (anyOf 1).modules[].business_card_fields[]	JSON	Each item	Represents a field reference in the business card view.
$ (anyOf 1).modules[].business_card_fields[] (anyOf 1)	object	Alternative	Field reference with API name and unique identifier Additional keys: not allowed
$ (anyOf 1).modules[].business_card_fields[] (anyOf 1).api_name	string	Required within parent	API name of the field Maximum length: 50
$ (anyOf 1).modules[].business_card_fields[] (anyOf 1).id	string	Required within parent	Unique identifier of the field Format: int64
$ (anyOf 1).modules[].business_card_fields[] (anyOf 2)	string	Alternative	Field API name Maximum length: 50
$ (anyOf 1).modules[].cc_enabled	boolean	Optional	True when CommandCenter (workflow orchestration) is enabled for this module; false when not configured or unsupported.
$ (anyOf 1).modules[].chart_view	boolean	Optional	True when chart view is currently enabled for this module. Distinct from chart_view_supported, which reflects capability.
$ (anyOf 1).modules[].chart_view_supported	boolean	Optional	True when the module’s data structure supports chart visualization. A false value means chart view cannot be enabled regardless of settings.
$ (anyOf 1).modules[].convertable	boolean	Optional	True when records in this module can be converted to records in another module (e.g., Leads to Contacts/Accounts).
$ (anyOf 1).modules[].creatable	boolean	Optional	True when new records can be created in this module; false for read-only modules such as analytics or configuration entities.
$ (anyOf 1).modules[].custom_view	JSON	Optional
$ (anyOf 1).modules[].custom_view (anyOf 1)	object	Alternative	Default custom view configuration for the module, including filter criteria, display fields, sort settings, and sharing options. Exposed only when ‘custom_view’ is included in the include parameter. Additional keys: not allowed
$ (anyOf 1).modules[].custom_view (anyOf 1).$modified_criteria	boolean	Optional	True when the filter criteria of this custom view have been modified from their original configuration.
$ (anyOf 1).modules[].custom_view (anyOf 1).access_type	string	Required within parent	Access scope for the custom view, determining visibility to other users (e.g., private, shared with all, shared with roles). Known values: shared, public, only_to_me
$ (anyOf 1).modules[].custom_view (anyOf 1).category	string	Required within parent	Integer code representing the sharing category of the custom view (e.g., private, shared_with_everyone, shared_with_roles). Known values: created_by_me, shared_with_me, public_views
$ (anyOf 1).modules[].custom_view (anyOf 1).created_by	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).created_by (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_eeb47d537d32
$ (anyOf 1).modules[].custom_view (anyOf 1).created_by (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_0a006039d025
$ (anyOf 1).modules[].custom_view (anyOf 1).created_time	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).created_time (anyOf 1)	string	Alternative	ISO 8601 datetime when the custom view was created, including timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for system views. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 1).created_time (anyOf 2)	null	Alternative	ISO 8601 datetime when the custom view was created, including timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for system views. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 1).criteria	JSON	Required within parent	Represents the filter criteria applied to this Custom View.
$ (anyOf 1).modules[].custom_view (anyOf 1).criteria (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views criteria comparator, field, type, value
$ (anyOf 1).modules[].custom_view (anyOf 1).criteria (anyOf 2)	null	Alternative	No filter criteria applied.
$ (anyOf 1).modules[].custom_view (anyOf 1).cross_filters	array	Optional	Array of cross-module filter objects enabling advanced filtering based on related module conditions (e.g., filter Contacts by associated Deals criteria). Maximum items: 3 Minimum items: 1
$ (anyOf 1).modules[].custom_view (anyOf 1).cross_filters[]	object	Each item	Cross-filter criterion object defining filtering logic for related modules. Additional keys: allowed
$ (anyOf 1).modules[].custom_view (anyOf 1).default	boolean	Required within parent	True when this custom view is the default view loaded for the module; only one view per module can be the default.
$ (anyOf 1).modules[].custom_view (anyOf 1).display_value	string	Required within parent	Human-readable label for the custom view as displayed in the CRM UI. Maximum 100 characters. Maximum length: 100
$ (anyOf 1).modules[].custom_view (anyOf 1).favorite	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).favorite (anyOf 1)	JSON	Alternative
$ (anyOf 1).modules[].custom_view (anyOf 1).favorite (anyOf 1) (anyOf 1)	integer	Alternative	Numeric ranking position of this view in the user’s favorites list. Null when the view has not been marked as a favorite. Format: int32
$ (anyOf 1).modules[].custom_view (anyOf 1).favorite (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].custom_view (anyOf 1).favorite (anyOf 2)	null	Alternative	Numeric ranking position of this view in the user’s favorites list. Null when the view has not been marked as a favorite. Format: int32
$ (anyOf 1).modules[].custom_view (anyOf 1).fields	array	Required within parent	Ordered list of field objects to display as columns in this custom view, each identified by api_name and id. Maximum items: 1000
$ (anyOf 1).modules[].custom_view (anyOf 1).fields[]	Model	Each item	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views fields item
$ (anyOf 1).modules[].custom_view (anyOf 1).id	string	Required within parent	Unique numeric identifier (as string) for this custom view. Format: int64
$ (anyOf 1).modules[].custom_view (anyOf 1).last_accessed_time	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).last_accessed_time (anyOf 1)	string	Alternative	ISO 8601 datetime when this view was last accessed, including timezone offset. Null if never accessed after creation. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 1).last_accessed_time (anyOf 2)	null	Alternative	ISO 8601 datetime when this view was last accessed, including timezone offset. Null if never accessed after creation. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 1).locked	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).locked (anyOf 1)	boolean	Alternative	True when the view is locked by an administrator; locked views cannot be modified or deleted by regular users. Default: false
$ (anyOf 1).modules[].custom_view (anyOf 1).locked (anyOf 2)	null	Alternative	True when the view is locked by an administrator; locked views cannot be modified or deleted by regular users. Default: false
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_by	JSON	Required within parent	Represents the user who last modified this Custom View.
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_by (anyOf 1)	object	Alternative	User who last modified this custom view. Null for system views that have never been modified. Additional keys: not allowed
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_by (anyOf 1).id	string	Required within parent	Unique identifier of the user who modified the custom view. Format: int64
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_by (anyOf 1).name	string	Required within parent	Name of the user who modified the custom view. Maximum length: 101
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_by (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_time	JSON	Required within parent	Represents the timestamp when this Custom View was last modified, in ISO 8601 format.
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_time (anyOf 1)	string	Alternative	Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 1).modified_time (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].custom_view (anyOf 1).module	Model	Optional	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views module
$ (anyOf 1).modules[].custom_view (anyOf 1).name	string	Required within parent	System name identifier for the custom view, distinct from display_value. Maximum 50 characters. Maximum length: 100
$ (anyOf 1).modules[].custom_view (anyOf 1).offline	boolean	Optional	True when this view is available for offline access in Zoho CRM mobile applications. Only exposed for crmmobile and routeiq services.
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 1)	array	Alternative	Array of sharing target objects (users, roles, groups, or territories) with whom this custom view is shared. Null for public or non-shared views. Maximum items: 100
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 1)[]	JSON	Each item	Represents a sharing entry defining an entity that this Custom View is shared with.
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 1)[] (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 2)	null	Alternative	Array of sharing target objects (users, roles, groups, or territories) with whom this custom view is shared. Null for public or non-shared views. Maximum items: 100
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 2)[]	JSON	Each item	Represents a sharing entry defining an entity that this Custom View is shared with.
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 2)[] (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb
$ (anyOf 1).modules[].custom_view (anyOf 1).shared_to (anyOf 2)[] (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625
$ (anyOf 1).modules[].custom_view (anyOf 1).sort_by	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).sort_by (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_7f4ade2b2bbe
$ (anyOf 1).modules[].custom_view (anyOf 1).sort_by (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_9fe373614add
$ (anyOf 1).modules[].custom_view (anyOf 1).sort_order	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).sort_order (anyOf 1)	string	Alternative	Sort direction applied to this view. Possible values: asc - ascending order; desc - descending order; null - no sort order is configured. Known values: asc, desc
$ (anyOf 1).modules[].custom_view (anyOf 1).sort_order (anyOf 2)	null	Alternative	Sort direction applied to this view. Possible values: asc - ascending order; desc - descending order; null - no sort order is configured. Known values: asc, desc
$ (anyOf 1).modules[].custom_view (anyOf 1).system_defined	boolean	Required within parent	True when this custom view was created automatically by the system; false when created by a user.
$ (anyOf 1).modules[].custom_view (anyOf 1).system_name	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 1).system_name (anyOf 1)	string	Alternative	Internal system name for this custom view, stored separately from the user-visible display_value. Nullable; maximum 255 characters. Maximum length: 255
$ (anyOf 1).modules[].custom_view (anyOf 1).system_name (anyOf 2)	null	Alternative	Internal system name for this custom view, stored separately from the user-visible display_value. Nullable; maximum 255 characters. Maximum length: 255
$ (anyOf 1).modules[].custom_view (anyOf 1).wrap_text	boolean	Optional	True when text wrapping is enabled for field values displayed in this custom view; false when values are truncated to a single line.
$ (anyOf 1).modules[].custom_view (anyOf 2)	null	Alternative	Default custom view configuration for the module, including filter criteria, display fields, sort settings, and sharing options. Exposed only when ‘custom_view’ is included in the include parameter. Additional keys: not allowed
$ (anyOf 1).modules[].custom_view (anyOf 2).$modified_criteria	boolean	Optional	True when the filter criteria of this custom view have been modified from their original configuration.
$ (anyOf 1).modules[].custom_view (anyOf 2).access_type	string	Required within parent	Access scope for the custom view, determining visibility to other users (e.g., private, shared with all, shared with roles). Known values: shared, public, only_to_me
$ (anyOf 1).modules[].custom_view (anyOf 2).category	string	Required within parent	Integer code representing the sharing category of the custom view (e.g., private, shared_with_everyone, shared_with_roles). Known values: created_by_me, shared_with_me, public_views
$ (anyOf 1).modules[].custom_view (anyOf 2).created_by	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).created_by (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_eeb47d537d32
$ (anyOf 1).modules[].custom_view (anyOf 2).created_by (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_0a006039d025
$ (anyOf 1).modules[].custom_view (anyOf 2).created_time	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).created_time (anyOf 1)	string	Alternative	ISO 8601 datetime when the custom view was created, including timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for system views. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 2).created_time (anyOf 2)	null	Alternative	ISO 8601 datetime when the custom view was created, including timezone offset (e.g., 2025-11-20T14:30:00+05:30). Null for system views. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 2).criteria	JSON	Required within parent	Represents the filter criteria applied to this Custom View.
$ (anyOf 1).modules[].custom_view (anyOf 2).criteria (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views criteria comparator, field, type, value
$ (anyOf 1).modules[].custom_view (anyOf 2).criteria (anyOf 2)	null	Alternative	No filter criteria applied.
$ (anyOf 1).modules[].custom_view (anyOf 2).cross_filters	array	Optional	Array of cross-module filter objects enabling advanced filtering based on related module conditions (e.g., filter Contacts by associated Deals criteria). Maximum items: 3 Minimum items: 1
$ (anyOf 1).modules[].custom_view (anyOf 2).cross_filters[]	object	Each item	Cross-filter criterion object defining filtering logic for related modules. Additional keys: allowed
$ (anyOf 1).modules[].custom_view (anyOf 2).default	boolean	Required within parent	True when this custom view is the default view loaded for the module; only one view per module can be the default.
$ (anyOf 1).modules[].custom_view (anyOf 2).display_value	string	Required within parent	Human-readable label for the custom view as displayed in the CRM UI. Maximum 100 characters. Maximum length: 100
$ (anyOf 1).modules[].custom_view (anyOf 2).favorite	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).favorite (anyOf 1)	JSON	Alternative
$ (anyOf 1).modules[].custom_view (anyOf 2).favorite (anyOf 1) (anyOf 1)	integer	Alternative	Numeric ranking position of this view in the user’s favorites list. Null when the view has not been marked as a favorite. Format: int32
$ (anyOf 1).modules[].custom_view (anyOf 2).favorite (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].custom_view (anyOf 2).favorite (anyOf 2)	null	Alternative	Numeric ranking position of this view in the user’s favorites list. Null when the view has not been marked as a favorite. Format: int32
$ (anyOf 1).modules[].custom_view (anyOf 2).fields	array	Required within parent	Ordered list of field objects to display as columns in this custom view, each identified by api_name and id. Maximum items: 1000
$ (anyOf 1).modules[].custom_view (anyOf 2).fields[]	Model	Each item	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views fields item
$ (anyOf 1).modules[].custom_view (anyOf 2).id	string	Required within parent	Unique numeric identifier (as string) for this custom view. Format: int64
$ (anyOf 1).modules[].custom_view (anyOf 2).last_accessed_time	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).last_accessed_time (anyOf 1)	string	Alternative	ISO 8601 datetime when this view was last accessed, including timezone offset. Null if never accessed after creation. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 2).last_accessed_time (anyOf 2)	null	Alternative	ISO 8601 datetime when this view was last accessed, including timezone offset. Null if never accessed after creation. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 2).locked	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).locked (anyOf 1)	boolean	Alternative	True when the view is locked by an administrator; locked views cannot be modified or deleted by regular users. Default: false
$ (anyOf 1).modules[].custom_view (anyOf 2).locked (anyOf 2)	null	Alternative	True when the view is locked by an administrator; locked views cannot be modified or deleted by regular users. Default: false
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_by	JSON	Required within parent	Represents the user who last modified this Custom View.
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_by (anyOf 1)	object	Alternative	User who last modified this custom view. Null for system views that have never been modified. Additional keys: not allowed
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_by (anyOf 1).id	string	Required within parent	Unique identifier of the user who modified the custom view. Format: int64
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_by (anyOf 1).name	string	Required within parent	Name of the user who modified the custom view. Maximum length: 101
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_by (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_time	JSON	Required within parent	Represents the timestamp when this Custom View was last modified, in ISO 8601 format.
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_time (anyOf 1)	string	Alternative	Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified. Format: date-time
$ (anyOf 1).modules[].custom_view (anyOf 2).modified_time (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].custom_view (anyOf 2).module	Model	Optional	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views module
$ (anyOf 1).modules[].custom_view (anyOf 2).name	string	Required within parent	System name identifier for the custom view, distinct from display_value. Maximum 50 characters. Maximum length: 100
$ (anyOf 1).modules[].custom_view (anyOf 2).offline	boolean	Optional	True when this view is available for offline access in Zoho CRM mobile applications. Only exposed for crmmobile and routeiq services.
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 1)	array	Alternative	Array of sharing target objects (users, roles, groups, or territories) with whom this custom view is shared. Null for public or non-shared views. Maximum items: 100
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 1)[]	JSON	Each item	Represents a sharing entry defining an entity that this Custom View is shared with.
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 1)[] (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 1)[] (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 2)	null	Alternative	Array of sharing target objects (users, roles, groups, or territories) with whom this custom view is shared. Null for public or non-shared views. Maximum items: 100
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 2)[]	JSON	Each item	Represents a sharing entry defining an entity that this Custom View is shared with.
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 2)[] (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb
$ (anyOf 1).modules[].custom_view (anyOf 2).shared_to (anyOf 2)[] (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625
$ (anyOf 1).modules[].custom_view (anyOf 2).sort_by	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).sort_by (anyOf 1)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_7f4ade2b2bbe
$ (anyOf 1).modules[].custom_view (anyOf 2).sort_by (anyOf 2)	Model	Alternative	Expand Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_9fe373614add
$ (anyOf 1).modules[].custom_view (anyOf 2).sort_order	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).sort_order (anyOf 1)	string	Alternative	Sort direction applied to this view. Possible values: asc - ascending order; desc - descending order; null - no sort order is configured. Known values: asc, desc
$ (anyOf 1).modules[].custom_view (anyOf 2).sort_order (anyOf 2)	null	Alternative	Sort direction applied to this view. Possible values: asc - ascending order; desc - descending order; null - no sort order is configured. Known values: asc, desc
$ (anyOf 1).modules[].custom_view (anyOf 2).system_defined	boolean	Required within parent	True when this custom view was created automatically by the system; false when created by a user.
$ (anyOf 1).modules[].custom_view (anyOf 2).system_name	JSON	Required within parent
$ (anyOf 1).modules[].custom_view (anyOf 2).system_name (anyOf 1)	string	Alternative	Internal system name for this custom view, stored separately from the user-visible display_value. Nullable; maximum 255 characters. Maximum length: 255
$ (anyOf 1).modules[].custom_view (anyOf 2).system_name (anyOf 2)	null	Alternative	Internal system name for this custom view, stored separately from the user-visible display_value. Nullable; maximum 255 characters. Maximum length: 255
$ (anyOf 1).modules[].custom_view (anyOf 2).wrap_text	boolean	Optional	True when text wrapping is enabled for field values displayed in this custom view; false when values are truncated to a single line.
$ (anyOf 1).modules[].default_mapping_fields	array	Optional	Array of default field mapping objects (up to 25) for data import and integration operations. Exposed only for SALESORDERS, INVOICES, QUOTES, QUOTEDITEMS, ORDEREDITEMS, and INVOICEDITEMS modules; each entry identifies a field by api_name and id. Maximum items: 25
$ (anyOf 1).modules[].default_mapping_fields[]	object	Each item	Field mapping configuration for import operations. Additional keys: not allowed
$ (anyOf 1).modules[].default_mapping_fields[].api_name	string	Required within parent	API name of the field in the default mapping configuration. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].default_mapping_fields[].id	string	Required within parent	Unique numeric identifier (as string) of the field in the default mapping configuration. Format: int64
$ (anyOf 1).modules[].deletable	boolean	Optional	True when records in this module can be permanently deleted; false for protected modules such as configuration entities or system-managed records.
$ (anyOf 1).modules[].description	JSON	Optional
$ (anyOf 1).modules[].description (anyOf 1)	string	Alternative	User-defined description of the module. Null when no description has been set. Maximum 255 characters; empty string should not be used. Maximum length: 255
$ (anyOf 1).modules[].description (anyOf 2)	null	Alternative	User-defined description of the module. Null when no description has been set. Maximum 255 characters; empty string should not be used. Maximum length: 255
$ (anyOf 1).modules[].display_field	JSON	Optional	Field designation used as the record display name or title in this module. Either a string containing the field’s API name, or an object with api_name and id.
$ (anyOf 1).modules[].display_field (anyOf 1)	string	Alternative	API name of the display field Maximum length: 50
$ (anyOf 1).modules[].display_field (anyOf 2)	object	Alternative	Display field object with detailed properties Additional keys: not allowed
$ (anyOf 1).modules[].display_field (anyOf 2).api_name	string	Required within parent	API name of the display field Maximum length: 50
$ (anyOf 1).modules[].display_field (anyOf 2).id	string	Required within parent	Unique identifier of the display field Format: int64
$ (anyOf 1).modules[].display_field (anyOf 3)	null	Alternative	No display field configured
$ (anyOf 1).modules[].editable	boolean	Optional	True when existing records in this module can be edited by users with appropriate permissions; false for read-only modules.
$ (anyOf 1).modules[].emailTemplate_support	boolean	Optional	True when email templates can be used to send emails from records in this module; false when email template functionality is not supported.
$ (anyOf 1).modules[].email_parser_supported	boolean	Optional	True when email parsing is supported for this module, enabling automatic record creation or updates from inbound emails.
$ (anyOf 1).modules[].feeds_required	boolean	Optional	True when activity feeds are enabled for this module, displaying a timeline of record activities and updates.
$ (anyOf 1).modules[].fields	array	Optional	Array of complete field metadata objects (up to 1000) for all fields in this module. Populated only when ‘fields’ is included in the include query parameter and when the service is creator. Maximum items: 1000
$ (anyOf 1).modules[].fields[]	object	Each item	Field metadata object containing properties, data type, and configuration. Additional keys: allowed
$ (anyOf 1).modules[].filter_status	boolean	Optional	True when custom view filters are currently active for this module; false when no active filter state is set.
$ (anyOf 1).modules[].filter_supported	boolean	Optional	True when this module supports custom view filtering; false for modules that do not allow filter configuration.
$ (anyOf 1).modules[].generated_type	string	Optional	Classification of how this module was generated. Possible values: default - standard system module; custom - user-created module; web - web tab module; linking - many-to-many linking module; subform - dynamic subform module; static_subform - static subform; field_tracker - field change tracker; picklisttracker - picklist change tracker. Known values: field_tracker, default, web, linking, custom, picklisttracker, subform, static_subform
$ (anyOf 1).modules[].global_search_supported	boolean	Optional	True when records in this module appear in global search results; false when the module is excluded from global search.
$ (anyOf 1).modules[].has_more_profiles	boolean	Optional	True when the profiles array is truncated and additional profiles exist beyond those returned (pagination indicator); false when the full profile list is included.
$ (anyOf 1).modules[].id	string	Required within parent	Unique numeric identifier (as string) for this module. Required field; used as the stable reference across all API operations. Format: int64
$ (anyOf 1).modules[].inventory_template_supported	boolean	Optional	True when inventory templates (e.g., for quotes, invoices) can be configured for this module; false when not supported.
$ (anyOf 1).modules[].isBlueprintSupported	boolean	Optional	True when Blueprint process automation can be configured for this module; false when Blueprint is not available for this module type.
$ (anyOf 1).modules[].kanban_view	boolean	Optional	True when kanban view is currently enabled for this module. Distinct from kanban_view_supported, which reflects capability regardless of current setting.
$ (anyOf 1).modules[].kanban_view_supported	boolean	Optional	True when the module’s data structure supports kanban view. A false value means kanban view cannot be enabled regardless of settings.
$ (anyOf 1).modules[].layouts	array	Optional	Array of layout configuration objects (up to 7) available for this module, ordered by relevance of profiles and record creation for the current user. Populated only when ‘layouts’ is included in the include query parameter. Maximum items: 7
$ (anyOf 1).modules[].layouts[]	object	Each item	Layout configuration object containing layout metadata, profile associations, and field arrangements. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].actions_allowed	object	Optional	Object enumerating the operations that the current user can perform on this layout, including flags for clone, deactivate, delete, downgrade, edit, rename, and configure permissions. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].actions_allowed.clone	boolean	Required within parent	True when the current user has permission to clone this layout.
$ (anyOf 1).modules[].layouts[].actions_allowed.deactivate	boolean	Required within parent	True when the current user has permission to deactivate this layout.
$ (anyOf 1).modules[].layouts[].actions_allowed.delete	boolean	Required within parent	True when the current user has permission to delete this layout.
$ (anyOf 1).modules[].layouts[].actions_allowed.downgrade	boolean	Required within parent	True when the current user has permission to downgrade this layout to a simpler layout type.
$ (anyOf 1).modules[].layouts[].actions_allowed.edit	boolean	Required within parent	True when the current user has permission to edit the fields and settings of this layout.
$ (anyOf 1).modules[].layouts[].actions_allowed.rename	boolean	Required within parent	True when the current user has permission to rename this layout.
$ (anyOf 1).modules[].layouts[].actions_allowed.set_layout_permissions	boolean	Required within parent	True when the current user has permission to configure profile-based access permissions for this layout.
$ (anyOf 1).modules[].layouts[].api_name	string	Optional	API name used to reference this layout in API requests. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping	object	Optional	Conversion mapping configuration defining target modules (Accounts, Contacts, Deals) and field-level mappings when records in this module are converted. Populated only when ‘convert_mapping’ is included in the include parameter. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.Accounts	object	Optional	Configuration object for converting this module’s records to Accounts, including the Account module’s display label, id, and internal name. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.Accounts.display_label	string	Required within parent	Human-readable display label for the Accounts module shown in the conversion UI. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Accounts.id	string	Required within parent	Unique numeric identifier (as string) for the Accounts module used as the conversion target. Format: int64
$ (anyOf 1).modules[].layouts[].convert_mapping.Accounts.name	string	Required within parent	Internal system name of the Accounts module. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Contacts	object	Optional	Configuration object for converting this module’s records to Contacts, including the Contacts module’s display label, id, and internal name. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.Contacts.display_label	string	Required within parent	Human-readable display label for the Contacts module shown in the conversion UI. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Contacts.id	string	Required within parent	Unique numeric identifier (as string) for the Contacts module used as the conversion target. Format: int64
$ (anyOf 1).modules[].layouts[].convert_mapping.Contacts.name	string	Required within parent	Internal system name of the Contacts module. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals	object	Optional	Configuration object for converting this module’s records to Deals, including the Deals module’s display label, id, internal name, and an array of field-level mapping configurations. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.display_label	string	Required within parent	Human-readable display label for the Deals module shown in the conversion UI. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.fields	array	Required within parent	Array of field mapping objects (up to 1000) specifying how source module fields map to Deals fields during conversion; each entry contains the Deals field api_name, display label, id, and whether the field is required. Maximum items: 1000
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.fields[]	object	Each item	Field mapping configuration specifying a single field for conversion. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.fields[].api_name	string	Required within parent	API name of the target Deals field in this mapping. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.fields[].field_label	string	Required within parent	Human-readable display label for the Deals field in the conversion UI. Maximum 100 characters. Maximum length: 100
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.fields[].id	string	Required within parent	Unique numeric identifier (as string) of the Deals field in this mapping. Format: int64
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.fields[].required	boolean	Required within parent	True when this Deals field must be populated during the record conversion process; false when it is optional.
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.id	string	Required within parent	Unique numeric identifier (as string) for the Deals module used as the conversion target. Format: int64
$ (anyOf 1).modules[].layouts[].convert_mapping.Deals.name	string	Required within parent	API name used internally to identify the Deals module within the conversion mapping. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Invoices	object	Optional	Conversion target configuration object for the Invoices module, containing display label and identifier details. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.Invoices.display_label	string	Required within parent	Human-readable label displayed for the Invoices module in the conversion mapping. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.Invoices.id	string	Required within parent	Unique numeric identifier (as string) for the Invoices module in the conversion mapping. Format: int64
$ (anyOf 1).modules[].layouts[].convert_mapping.Invoices.name	string	Required within parent	API name used internally to identify the Invoices module within the conversion mapping. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.SalesOrders	object	Optional	Conversion target configuration object for the SalesOrders module, containing display label and identifier details. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].convert_mapping.SalesOrders.display_label	string	Required within parent	Human-readable label displayed for the SalesOrders module in the conversion mapping. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].convert_mapping.SalesOrders.id	string	Required within parent	Unique numeric identifier (as string) for the SalesOrders module in the conversion mapping. Format: int64
$ (anyOf 1).modules[].layouts[].convert_mapping.SalesOrders.name	string	Required within parent	API name used internally to identify the SalesOrders module within the conversion mapping. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].created_by	JSON	Optional
$ (anyOf 1).modules[].layouts[].created_by (anyOf 1)	object	Alternative	User who created this layout, containing id and name. Null when created by the system. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].created_by (anyOf 1).id	string	Required within parent	Unique numeric identifier (as string) of the user who created the layout. Format: int64
$ (anyOf 1).modules[].layouts[].created_by (anyOf 1).name	string	Required within parent	Full name of the user who created the layout. Maximum 101 characters. Maximum length: 101
$ (anyOf 1).modules[].layouts[].created_by (anyOf 2)	null	Alternative	User who created this layout, containing id and name. Null when created by the system. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].created_by (anyOf 2).id	string	Required within parent	Unique numeric identifier (as string) of the user who created the layout. Format: int64
$ (anyOf 1).modules[].layouts[].created_by (anyOf 2).name	string	Required within parent	Full name of the user who created the layout. Maximum 101 characters. Maximum length: 101
$ (anyOf 1).modules[].layouts[].created_for	JSON	Optional
$ (anyOf 1).modules[].layouts[].created_for (anyOf 1)	string	Alternative	Identifier of the entity (user, profile, or role) for which this layout was created. Maximum 100 characters. Null if created for general use. Maximum length: 100
$ (anyOf 1).modules[].layouts[].created_for (anyOf 2)	null	Alternative	Identifier of the entity (user, profile, or role) for which this layout was created. Maximum 100 characters. Null if created for general use. Maximum length: 100
$ (anyOf 1).modules[].layouts[].created_time	JSON	Optional
$ (anyOf 1).modules[].layouts[].created_time (anyOf 1)	string	Alternative	ISO 8601 timestamp with timezone offset recording when the layout was created; nullable. Format: date-time
$ (anyOf 1).modules[].layouts[].created_time (anyOf 2)	null	Alternative	ISO 8601 timestamp with timezone offset recording when the layout was created; nullable. Format: date-time
$ (anyOf 1).modules[].layouts[].display_label	string	Required within parent	Human-readable label displayed in the UI for this layout. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].generated_type	string	Required within parent	Classification of how the layout was generated. Possible values: default - standard system layout; custom - user-created; web - web tab; linking - many-to-many; subform - dynamic subform; static_subform - static subform; orchestration - CommandCenter; field_tracker - field change tracker; webtab_slyteui - Slyte UI web tab; system - core system layout. Known values: default, web, custom, linking, subform, orchestration, field_tracker, webtab_slyteui, static_subform, system
$ (anyOf 1).modules[].layouts[].has_more_profiles	boolean	Optional	True when additional profiles beyond the current page are associated with this layout, signaling that further pagination is required.
$ (anyOf 1).modules[].layouts[].id	string	Required within parent	Unique numeric identifier (as string) for the layout. Format: int64
$ (anyOf 1).modules[].layouts[].modified_by	JSON	Optional	Represents the user who last modified this layout.
$ (anyOf 1).modules[].layouts[].modified_by (anyOf 1)	object	Alternative	User who last modified this custom view. Null for system views that have never been modified. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].modified_by (anyOf 1).id	string	Required within parent	Unique identifier of the user who modified the custom view. Format: int64
$ (anyOf 1).modules[].layouts[].modified_by (anyOf 1).name	string	Required within parent	Name of the user who modified the custom view. Maximum length: 101
$ (anyOf 1).modules[].layouts[].modified_by (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].layouts[].modified_time	JSON	Optional	Represents the timestamp when this layout was last modified, in ISO 8601 format.
$ (anyOf 1).modules[].layouts[].modified_time (anyOf 1)	string	Alternative	Timestamp when layout was last modified in ISO 8601 format with timezone offset. Null if never modified. Format: date-time
$ (anyOf 1).modules[].layouts[].modified_time (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].layouts[].name	string	Required within parent	Internal API name of the layout. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].profiles	array	Optional	Array of user profile objects (up to 202) that have access to this layout, each containing profile id, name, and default view configuration. Maximum items: 202
$ (anyOf 1).modules[].layouts[].profiles[]	object	Each item	Profile configuration with default view settings. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].profiles[]._default_assignment_view	object	Required within parent	Default assignment view configuration applied when records are assigned under this profile, controlling how record assignment operations are presented. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].profiles[]._default_assignment_view.id	string	Required within parent	Unique numeric identifier (as string) of the default assignment view associated with this profile. Format: int64
$ (anyOf 1).modules[].layouts[].profiles[]._default_assignment_view.name	string	Required within parent	Display name of the default assignment view. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].profiles[]._default_assignment_view.type	string	Required within parent	Category of the default assignment view. Possible values: inventory_templates, layout, canvas, wizard. Known values: inventory_templates, layout, canvas, wizard
$ (anyOf 1).modules[].layouts[].profiles[]._default_view	object	Required within parent	Default custom view configuration applied to this profile, determining the initial view presented to users accessing records. Additional keys: not allowed
$ (anyOf 1).modules[].layouts[].profiles[]._default_view.id	string	Required within parent	Unique numeric identifier (as string) of the default view associated with this profile. Format: int64
$ (anyOf 1).modules[].layouts[].profiles[]._default_view.name	string	Required within parent	Display name of the default custom view. Maximum 40 characters. Maximum length: 40
$ (anyOf 1).modules[].layouts[].profiles[]._default_view.type	string	Required within parent	Category of the default custom view. Possible values: inventory_templates, layout, canvas, wizard. Known values: inventory_templates, layout, canvas, wizard
$ (anyOf 1).modules[].layouts[].profiles[].default	boolean	Required within parent	True when this profile serves as the default profile for the layout.
$ (anyOf 1).modules[].layouts[].profiles[].id	string	Required within parent	Unique numeric identifier (as string) for this profile. Format: int64
$ (anyOf 1).modules[].layouts[].profiles[].name	string	Required within parent	Name identifying the profile associated with this layout. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].layouts[].sections	array	Optional	Ordered list of sections grouping fields within the layout. Maximum 7 sections. Maximum items: 7
$ (anyOf 1).modules[].layouts[].sections[]	object	Each item	Section configuration with fields and display settings. Additional keys: allowed
$ (anyOf 1).modules[].layouts[].show_business_card	boolean	Optional	True when the business card view is enabled for this layout.
$ (anyOf 1).modules[].layouts[].source	string	Required within parent	Source system that originated the layout configuration. Possible values: crm, platform_plugin, marketplace_plugin, campaign_integration. Known values: crm, platform_plugin, marketplace_plugin, campaign_integration
$ (anyOf 1).modules[].layouts[].status	string	Required within parent	Current lifecycle state of the layout. Possible values: active - in use; inactive - disabled; downgraded - reduced to simpler type; hidden - not visible in UI. Known values: active, inactive, downgraded, hidden
$ (anyOf 1).modules[].layouts[].visible	boolean	Optional	True when the layout is visible and accessible to users.
$ (anyOf 1).modules[].lookup_field_properties	JSON	Optional
$ (anyOf 1).modules[].lookup_field_properties (anyOf 1)	object	Alternative	Configuration properties governing lookup field behavior for this module. Null when the module has no lookup field configuration. Additional keys: allowed
$ (anyOf 1).modules[].lookup_field_properties (anyOf 2)	null	Alternative	Configuration properties governing lookup field behavior for this module. Null when the module has no lookup field configuration. Additional keys: allowed
$ (anyOf 1).modules[].lookupable	boolean	Optional	True when this module can be targeted as a lookup field by other modules.
$ (anyOf 1).modules[].masked_fields_count	JSON	Optional
$ (anyOf 1).modules[].masked_fields_count (anyOf 1)	integer	Alternative	Count of masked fields in this module. Exposed only when the ‘fields’ include parameter is specified. Format: int32
$ (anyOf 1).modules[].masked_fields_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].modified_by	JSON	Optional	Represents the user who last modified this module configuration.
$ (anyOf 1).modules[].modified_by (anyOf 1)	object	Alternative	User who last modified this custom view. Null for system views that have never been modified. Additional keys: not allowed
$ (anyOf 1).modules[].modified_by (anyOf 1).id	string	Required within parent	Unique identifier of the user who modified the custom view. Format: int64
$ (anyOf 1).modules[].modified_by (anyOf 1).name	string	Required within parent	Name of the user who modified the custom view. Maximum length: 101
$ (anyOf 1).modules[].modified_by (anyOf 2)	null	Alternative	Indicates that has never been modified.
$ (anyOf 1).modules[].modified_time	JSON	Optional
$ (anyOf 1).modules[].modified_time (anyOf 1)	string	Alternative	ISO 8601 timestamp with timezone offset recording when the module configuration was last modified. Null when the module has never been modified after creation. Format: date-time
$ (anyOf 1).modules[].modified_time (anyOf 2)	null	Alternative	ISO 8601 timestamp with timezone offset recording when the module configuration was last modified. Null when the module has never been modified after creation. Format: date-time
$ (anyOf 1).modules[].module_name	string	Optional	System-level API name identifying the module, used in API requests and responses. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].module_type	string	Optional	Categorizes the module as ENTITIES for standard data modules or CONFIGURATION_ENTITIES for configuration and settings modules. Known values: CONFIGURATION_ENTITIES, ENTITIES
$ (anyOf 1).modules[].parent_module	object	Optional	Reference to the parent module for child modules such as subforms and field trackers. Returns an empty object {} for standalone modules. This is populated with api_name and id for modules with parent relationships. Additional keys: not allowed
$ (anyOf 1).modules[].parent_module.api_name	string	Optional	API name of the parent module, used to identify it in API calls. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].parent_module.id	string	Optional	Unique numeric identifier (as string) of the parent module. Format: int64
$ (anyOf 1).modules[].per_page	JSON	Optional
$ (anyOf 1).modules[].per_page (anyOf 1)	integer	Alternative	Default number of records displayed per page when listing data for this module. Format: int32
$ (anyOf 1).modules[].per_page (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].plural_label	string	Optional	Localized plural display label for the module as shown in the UI, reflecting the active language setting. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].presence_sub_menu	boolean	Optional	True when the presence submenu is available for this module.
$ (anyOf 1).modules[].private_profile	JSON	Optional
$ (anyOf 1).modules[].private_profile (anyOf 1)	object	Alternative	Private profile configuration for team-based access control. Populated only when access_type is ‘team_based’ with profile name and ID; null for org_based modules. Additional keys: not allowed
$ (anyOf 1).modules[].private_profile (anyOf 1).id	string	Required within parent	Unique numeric identifier (as string) of the private profile. Format: int64
$ (anyOf 1).modules[].private_profile (anyOf 1).name	string	Required within parent	Display name of the private profile; maximum 101 characters. Maximum length: 101
$ (anyOf 1).modules[].private_profile (anyOf 2)	null	Alternative	Private profile configuration for team-based access control. Populated only when access_type is ‘team_based’ with profile name and ID; null for org_based modules. Additional keys: not allowed
$ (anyOf 1).modules[].private_profile (anyOf 2).id	string	Required within parent	Unique numeric identifier (as string) of the private profile. Format: int64
$ (anyOf 1).modules[].private_profile (anyOf 2).name	string	Required within parent	Display name of the private profile; maximum 101 characters. Maximum length: 101
$ (anyOf 1).modules[].profile_count	JSON	Optional
$ (anyOf 1).modules[].profile_count (anyOf 1)	integer	Alternative	Count of profiles assigned to this module; 0 indicates no profile assignments are configured. Maximum 203 profiles per module. Format: int32
$ (anyOf 1).modules[].profile_count (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].profiles	array	Optional	Profiles with access to this module; contains up to 203 entries. Maximum items: 203
$ (anyOf 1).modules[].profiles[]	object	Each item	Profile reference with ID and name Additional keys: not allowed
$ (anyOf 1).modules[].profiles[].id	string	Required within parent	Unique numeric identifier of the profile (as string). Format: int64
$ (anyOf 1).modules[].profiles[].name	string	Optional	Display name of the profile; maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].public_fields_configured	boolean	Optional	True when public fields have been configured for this module.
$ (anyOf 1).modules[].quick_create	boolean	Optional	True when quick create functionality is enabled for this module.
$ (anyOf 1).modules[].recycle_bin_on_delete	boolean	Optional	True when deleted records are moved to the recycle bin instead of being permanently deleted.
$ (anyOf 1).modules[].related_list_properties	JSON	Optional
$ (anyOf 1).modules[].related_list_properties (anyOf 1)	object	Alternative	Configuration and settings for related lists in this module; null when no related-list properties are defined. Additional keys: allowed
$ (anyOf 1).modules[].related_list_properties (anyOf 2)	null	Alternative	Configuration and settings for related lists in this module; null when no related-list properties are defined. Additional keys: allowed
$ (anyOf 1).modules[].related_lists	array	Optional	Related lists (subforms and related modules) displayed in this module’s detail view; populated only when ‘related_lists’ is included in the include query parameter. Maximum items: 2147483647
$ (anyOf 1).modules[].related_lists[]	object	Each item	Related list configuration defining how related module records are displayed and managed within the parent module’s detail view. Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties	array	Optional	Per-layout configuration entries governing how this related list appears within each associated layout; contains up to 2,147,483,647 items. Maximum items: 2147483647
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[]	object	Each item	Layout-specific configuration object containing sequence number and layout reference for a related list in a particular layout Additional keys: allowed
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[].layout	object	Required within parent	Layout reference object identifying the specific layout to which this related list configuration applies. Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[].layout.id	string	Optional	Unique numeric identifier (as string) for the layout. Format: int64
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[].layout.name	string	Optional	Display name of the layout, up to 40 characters. Maximum length: 40
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[].sequence_number	JSON	Required within parent
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[].sequence_number (anyOf 1)	integer	Alternative	Numeric position defining the display order of this related list within its associated layout. Format: int32
$ (anyOf 1).modules[].related_lists[]._layout_specific_properties[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].related_lists[].action	JSON	Required within parent
$ (anyOf 1).modules[].related_lists[].action (anyOf 1)	string	Alternative	Action URL or operation identifier associated with this related list, up to 64 characters; null when no action is defined. Maximum length: 64
$ (anyOf 1).modules[].related_lists[].action (anyOf 2)	null	Alternative	Action URL or operation identifier associated with this related list, up to 64 characters; null when no action is defined. Maximum length: 64
$ (anyOf 1).modules[].related_lists[].api_name	string	Required within parent	API name used to reference this related list programmatically, up to 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].connectedlookupApiName	string	Optional	API name of the connected lookup field linking this related list to another module, up to 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].connectedmodule	JSON	Optional
$ (anyOf 1).modules[].related_lists[].connectedmodule (anyOf 1)	string	Alternative	API name of the connected module for this related list; null when no module connection exists. Between 1 and 250 alphanumeric or underscore characters when present. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$
$ (anyOf 1).modules[].related_lists[].connectedmodule (anyOf 2)	null	Alternative	API name of the connected module for this related list; null when no module connection exists. Between 1 and 250 alphanumeric or underscore characters when present. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$
$ (anyOf 1).modules[].related_lists[].customize_display_label	boolean	Required within parent	True when the display label for this related list can be customized.
$ (anyOf 1).modules[].related_lists[].customize_fields	boolean	Required within parent	True when fields in this related list can be customized.
$ (anyOf 1).modules[].related_lists[].customize_sort	boolean	Required within parent	True when sorting for this related list can be customized.
$ (anyOf 1).modules[].related_lists[].display_label	string	Required within parent	UI display label for this related list. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].field_enabled	boolean	Optional	True when this related list field is enabled and active.
$ (anyOf 1).modules[].related_lists[].fields	array	Optional	List of fields displayed in this related list. Maximum 1000 items. Maximum items: 1000
$ (anyOf 1).modules[].related_lists[].fields[]	object	Each item	Field reference containing the API name and unique identifier of a field displayed in the related list. Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[].fields[].api_name	string	Required within parent	API name of the field used in programmatic access. Maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].fields[].id	string	Required within parent	Unique numeric identifier of the field, returned as a string. Format: int64
$ (anyOf 1).modules[].related_lists[].href	JSON	Required within parent
$ (anyOf 1).modules[].related_lists[].href (anyOf 1)	string	Alternative	Reference URL for the related list, or null if not applicable. Between 1 and 2048 characters when present. Maximum length: 2048 Minimum length: 1
$ (anyOf 1).modules[].related_lists[].href (anyOf 2)	null	Alternative	Reference URL for the related list, or null if not applicable. Between 1 and 2048 characters when present. Maximum length: 2048 Minimum length: 1
$ (anyOf 1).modules[].related_lists[].id	string	Required within parent	Unique numeric identifier of the related list, returned as a string. Format: int64
$ (anyOf 1).modules[].related_lists[].linkingmodule	JSON	Optional
$ (anyOf 1).modules[].related_lists[].linkingmodule (anyOf 1)	string	Alternative	API name of the linking module associated with this related list; null when no linking module is configured. Between 1 and 250 alphanumeric or underscore characters when present. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$
$ (anyOf 1).modules[].related_lists[].linkingmodule (anyOf 2)	null	Alternative	API name of the linking module associated with this related list; null when no linking module is configured. Between 1 and 250 alphanumeric or underscore characters when present. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$
$ (anyOf 1).modules[].related_lists[].module	JSON	Optional
$ (anyOf 1).modules[].related_lists[].module (anyOf 1)	object	Alternative	Module details associated with this related list entry, including its name and metadata; null if no module is linked. Additional keys: allowed
$ (anyOf 1).modules[].related_lists[].module (anyOf 2)	null	Alternative	Module details associated with this related list entry, including its name and metadata; null if no module is linked. Additional keys: allowed
$ (anyOf 1).modules[].related_lists[].name	string	Required within parent	System-level name identifying the related list module; maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].parent_related_lists	JSON	Optional
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 1)	array	Alternative	Array of parent related list references when this entry is nested within another related list; null for top-level related lists. Maximum 100 items. Maximum items: 100
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 1)[]	object	Each item	Parent related list reference object containing API name and unique identifier Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 1)[].api_name	string	Required within parent	API name of the parent related list containing this entry; maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 1)[].id	string	Required within parent	Unique numeric identifier (as string) of the parent related list. Format: int64
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 2)	null	Alternative	Array of parent related list references when this entry is nested within another related list; null for top-level related lists. Maximum 100 items. Maximum items: 100
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 2)[]	object	Each item	Parent related list reference object containing API name and unique identifier Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 2)[].api_name	string	Required within parent	API name of the parent related list containing this entry; maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].parent_related_lists (anyOf 2)[].id	string	Required within parent	Unique numeric identifier (as string) of the parent related list. Format: int64
$ (anyOf 1).modules[].related_lists[].personality_name	string	Optional	Personality name assigned to this related list configuration, distinguishing its behavioral variant; maximum 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].record_operations	object	Optional	Set of allowed record-level operations within this related list, such as create, edit, and assign. Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[].record_operations.assign	boolean	Required within parent	True when the assign operation is permitted for records in this related list.
$ (anyOf 1).modules[].related_lists[].record_operations.bulk_edit	boolean	Required within parent	True when bulk edit of records in this related list is permitted for the current user.
$ (anyOf 1).modules[].related_lists[].record_operations.create	boolean	Required within parent	True when creation of records within this related list is permitted for the current user.
$ (anyOf 1).modules[].related_lists[].record_operations.delete	boolean	Required within parent	True when deletion of associated records from this related list is permitted for the current user.
$ (anyOf 1).modules[].related_lists[].record_operations.disassociate	boolean	Required within parent	True when disassociation of records from this related list is permitted for the current user.
$ (anyOf 1).modules[].related_lists[].record_operations.edit	boolean	Required within parent	True when editing of records within this related list is permitted for the current user.
$ (anyOf 1).modules[].related_lists[].sequence_number	string	Required within parent	Display position of this related list; lower values appear first. Format: int32
$ (anyOf 1).modules[].related_lists[].sort_by	object	Optional	Field by which records in this related list are sorted by default; contains the field’s API name and unique identifier. Additional keys: not allowed
$ (anyOf 1).modules[].related_lists[].sort_by.api_name	string	Required within parent	API name of the field used for sorting, up to 50 characters. Maximum length: 50
$ (anyOf 1).modules[].related_lists[].sort_by.id	string	Required within parent	Unique numeric identifier (as string) of the field used for sorting records in this related list. Format: int64
$ (anyOf 1).modules[].related_lists[].sort_order	JSON	Optional
$ (anyOf 1).modules[].related_lists[].sort_order (anyOf 1)	string	Alternative	Sort direction applied to records in this related list. Possible values: asc - ascending; desc - descending; null - no sort order configured. Known values: asc, desc
$ (anyOf 1).modules[].related_lists[].sort_order (anyOf 2)	null	Alternative	Sort direction applied to records in this related list. Possible values: asc - ascending; desc - descending; null - no sort order configured. Known values: asc, desc
$ (anyOf 1).modules[].related_lists[].status	string	Required within parent	Visibility status of this related list; currently only ‘visible’ is supported. Known values: visible
$ (anyOf 1).modules[].related_lists[].type	string	Required within parent	Classification of this related list. Possible values: default - standard related list; multiselectlookup - multi-select lookup; combined_view - combined view; custom_lookup - custom lookup; custom_related_list - custom related list; slyteui - Slyte UI; queries - query-based; custom_function - function-based; grouped - grouped list. Known values: multiselectlookup, combined_view, custom_lookup, custom_related_list, slyteui, queries, custom_function, grouped, default
$ (anyOf 1).modules[].related_lists[].visibility	JSON	Optional
$ (anyOf 1).modules[].related_lists[].visibility (anyOf 1)	integer	Alternative	Numeric code controlling where this related list appears or is hidden in the UI Format: int32
$ (anyOf 1).modules[].related_lists[].visibility (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].scoring_supported	boolean	Optional	True when lead or contact scoring is supported for this module
$ (anyOf 1).modules[].search_layout_fields	array	Optional	Up to 10 fields displayed in the search result layout for this module Maximum items: 10
$ (anyOf 1).modules[].search_layout_fields[]	string	Each item	Field reference with API name and unique identifier Maximum length: 25
$ (anyOf 1).modules[].sequence_number	JSON	Optional
$ (anyOf 1).modules[].sequence_number (anyOf 1)	integer	Alternative	Numeric position of this module in the navigation list; lower values appear first, ranging from 1 to 200 Format: int32
$ (anyOf 1).modules[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].show_as_tab	boolean	Optional	True when this module is rendered as a tab in the navigation UI
$ (anyOf 1).modules[].show_emailparser	boolean	Optional	True when the Email Parser feature is enabled for this module
$ (anyOf 1).modules[].show_googlesync	boolean	Optional	True when Google Contact Sync is enabled for this module
$ (anyOf 1).modules[].show_social	boolean	Optional	True when social tab features are enabled for this module
$ (anyOf 1).modules[].show_visitor	boolean	Optional	True when the ZLiveDesk visitor tracking feature is enabled for this module
$ (anyOf 1).modules[].show_webform	boolean	Optional	True when the web forms feature is enabled for this module
$ (anyOf 1).modules[].showfacebooksync	boolean	Optional	Indicates if the Facebook LeadChain Sync feature is enabled for this module
$ (anyOf 1).modules[].showleadchainsync	boolean	Optional	True when lead chain synchronization is enabled for this module; only exposed for the Leads module
$ (anyOf 1).modules[].showlinkedinsync	boolean	Optional	True when the LinkedIn LeadChain Sync feature is enabled for this module
$ (anyOf 1).modules[].showtiktoksync	boolean	Optional	True when the TikTok LeadChain Sync feature is enabled for this module
$ (anyOf 1).modules[].singular_label	string	Optional	Localized singular display label for the module, up to 50 characters Maximum length: 50
$ (anyOf 1).modules[].source	string	Optional	Origin of the module configuration. Possible values: crm - native CRM module; platform_plugin - module from a platform plugin; marketplace_plugin - module from a marketplace plugin; campaign_integration - module created via campaign integration Known values: crm, platform_plugin, marketplace_plugin, campaign_integration
$ (anyOf 1).modules[].static_subform_properties	object	Optional	Static subform configuration properties defined for fields within this module Additional keys: not allowed
$ (anyOf 1).modules[].static_subform_properties.fields	array	Required within parent	Field references included in the static subform, up to 1000 items Maximum items: 1000
$ (anyOf 1).modules[].static_subform_properties.fields[]	object	Each item	Field reference with API name and ID Additional keys: not allowed
$ (anyOf 1).modules[].static_subform_properties.fields[].api_name	string	Required within parent	API name of the static subform field, up to 50 characters Maximum length: 50
$ (anyOf 1).modules[].static_subform_properties.fields[].id	string	Required within parent	Unique numeric identifier of the static subform field, returned as a string Format: int64
$ (anyOf 1).modules[].status	string	Optional	Represents the visibility status of the module. Possible values: visible - module is active and visible; scheduled_for_deletion - module is queued for removal; user_hidden - hidden by user preference; system_hidden - hidden by system configuration Known values: visible, scheduled_for_deletion, user_hidden, system_hidden
$ (anyOf 1).modules[].sub_menu_available	boolean	Optional	True when a submenu is available for this module in the UI navigation
$ (anyOf 1).modules[].territory	JSON	Optional
$ (anyOf 1).modules[].territory (anyOf 1)	object	Alternative	Territory restriction applied to the module; null when territory management is not enabled for the organization Additional keys: not allowed
$ (anyOf 1).modules[].territory (anyOf 1).id	string	Optional	Unique identifier of the territory as a string-encoded numeric ID; ‘0’ indicates no territory restriction is applied Format: int64
$ (anyOf 1).modules[].territory (anyOf 1).name	string	Optional	Display name of the assigned territory (e.g., ‘All Territories’, ‘North America’) Maximum length: 50
$ (anyOf 1).modules[].territory (anyOf 1).subordinates	boolean	Optional	True when subordinate (child) territories are included within the scope of this territory restriction
$ (anyOf 1).modules[].territory (anyOf 2)	null	Alternative	Territory restriction applied to the module; null when territory management is not enabled for the organization Additional keys: not allowed
$ (anyOf 1).modules[].territory (anyOf 2).id	string	Optional	Unique identifier of the territory as a string-encoded numeric ID; ‘0’ indicates no territory restriction is applied Format: int64
$ (anyOf 1).modules[].territory (anyOf 2).name	string	Optional	Display name of the assigned territory (e.g., ‘All Territories’, ‘North America’) Maximum length: 50
$ (anyOf 1).modules[].territory (anyOf 2).subordinates	boolean	Optional	True when subordinate (child) territories are included within the scope of this territory restriction
$ (anyOf 1).modules[].track_current_data	boolean	Optional	True when current data tracking is enabled for records in this module
$ (anyOf 1).modules[].triggers_supported	boolean	Optional	True when workflow triggers are supported for this module
$ (anyOf 1).modules[].viewable	boolean	Optional	True when records in this module can be viewed by the current user
$ (anyOf 1).modules[].visibility	JSON	Optional
$ (anyOf 1).modules[].visibility (anyOf 1)	integer	Alternative	Bitwise integer flags controlling module and feature visibility, ranging from 1 to 16383. Base value 1 means fully visible. Add flag values to suppress specific UI surfaces: 2=web UI hidden, 4=tab menu, 8=lookup, 16=related list, 32=multi-select lookup, 64=module settings, 128=automation, 256=templates, 512=import, 1024=export, 4096=reports, 8192=API. Format: int32 Maximum: 16383 Minimum: 1
$ (anyOf 1).modules[].visibility (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 1).modules[].web_link	JSON	Optional
$ (anyOf 1).modules[].web_link (anyOf 1)	string	Alternative	URL associated with this module; null when no web link is configured
$ (anyOf 1).modules[].web_link (anyOf 2)	null	Alternative	URL associated with this module; null when no web link is configured
$ (anyOf 1).modules[].webform_supported	boolean	Optional	True when web forms can be created for this module
$ (anyOf 1).modules[].zia_view	boolean	Optional	True when Zia AI view is enabled for this module; applicable only to the Deals module
$ (anyOf 2)	null	Alternative

Referenced models: Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_0a006039d025, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_eeb47d537d32, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views criteria comparator, field, type, value, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views fields item, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views module, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_7f4ade2b2bbe, Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_9fe373614add

Schemas

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_0a006039d025

Field	Type	Presence	Description and constraints
$	null	Root	User object identifying who created this custom view, containing id and name. Null for system-generated views. Additional keys: not allowed
id	string	Required within parent	Unique numeric identifier (as string) of the CRM user who created this custom view. Format: int64
name	string	Required within parent	Display name of the CRM user who created this custom view. Maximum 101 characters. Maximum length: 101

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views created by id, name — shared_created-by_eeb47d537d32

Field	Type	Presence	Description and constraints
$	object	Root	User object identifying who created this custom view, containing id and name. Null for system-generated views. Additional keys: not allowed
id	string	Required within parent	Unique numeric identifier (as string) of the CRM user who created this custom view. Format: int64
name	string	Required within parent	Display name of the CRM user who created this custom view. Maximum 101 characters. Maximum length: 101

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views criteria comparator, field, type, value

Field	Type	Presence	Description and constraints
$	object	Root	Single filter criterion defining a field comparison condition. Additional keys: not allowed
comparator	string	Required within parent	Comparison operator used for filtering (e.g., equal, contains, greater_than, less_than). Maximum length: 15
field	object	Required within parent	Field reference specifying which field to filter on. Additional keys: not allowed
field.api_name	string	Required within parent	API name of the field to filter. Maximum length: 50
field.id	string	Required within parent	Unique identifier of the field. Format: int64
type	string	Required within parent	type of the field being filtered. Maximum length: 50
value	JSON	Required within parent	Filter value to compare against. Can be boolean, string, number, object, array, or null depending on field type and comparator.

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views fields item

Field	Type	Presence	Description and constraints
$	object	Root	Field configuration specifying which field to show and display settings. Additional keys: not allowed
_pin	boolean	Required within parent	True when this field column is pinned in the custom view, keeping it visible during horizontal scrolling.
api_name	string	Required within parent	API name of the field displayed as this view column. Maximum 50 characters. Maximum length: 50
id	string	Required within parent	Unique numeric identifier (as string) of the field displayed as this view column. Format: int64

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views module

Field	Type	Presence	Description and constraints
$	object	Root	Reference object identifying the module to which this custom view belongs, containing the module's unique identifier and API name. This is exposed only for client calls. Additional keys: not allowed
api_name	string	Required within parent	API name of the module this custom view belongs to. Maximum 50 characters. Maximum length: 50
id	string	Required within parent	Unique numeric identifier (as string) of the module this custom view belongs to. Format: int64

Get module metadata by API name — request body — path

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
moduleIdentifier	JSON	Required within parent
moduleIdentifier (anyOf 1)	string	Alternative	Unique numeric identifier. Numeric string representation of a 64-bit positive integer. Format: int64
moduleIdentifier (anyOf 2)	string	Alternative	API name of the module to retrieve. Case-sensitive identifier following specific naming rules: must start with a letter, contain only alphanumeric characters and underscores, cannot have consecutive underscores, and must end with alphanumeric character. Maximum length: 50 Pattern: ^[A-Za-z][A-Za-z0-9_]*[A-Za-z0-9]$

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_47bbdc5a1afb

Field	Type	Presence	Description and constraints
$	object	Root	Share target with subordinates included. Additional keys: not allowed
id	string	Required within parent	Unique identifier of the entity. Format: int64
name	string	Required within parent	Name of the entity (user, role, group, or territory). Maximum length: 50
subordinates	JSON	Required within parent
subordinates (anyOf 1)	boolean	Alternative	Indicates if subordinates of the specified entity are included in sharing. Known values: True
subordinates (anyOf 2)	null	Alternative	Indicates if subordinates of the specified entity are included in sharing. Known values: True
type	string	Required within parent	Type of entity the view is shared with (territories, roles, groups, users). Known values: territories, roles, groups, users

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views shared to null item type: territories, roles, groups, users — shared_shared-to_974890dad625

Field	Type	Presence	Description and constraints
$	object	Root	Share target without subordinates. Additional keys: not allowed
id	string	Required within parent	Unique identifier of the entity. Format: int64
name	string	Required within parent	Name of the entity (user, role, group, or territory). Maximum length: 50
subordinates	JSON	Required within parent
subordinates (anyOf 1)	boolean	Alternative	Indicates if subordinates are excluded from sharing. Known values: False
subordinates (anyOf 2)	null	Alternative	Indicates if subordinates are excluded from sharing. Known values: False
type	string	Required within parent	Type of entity the view is shared with (territories, roles, groups, users). Known values: territories, roles, groups, users

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_7f4ade2b2bbe

Field	Type	Presence	Description and constraints
$	object	Root	Field object specifying the column used to sort records in this view, containing api_name and id. Null when no sort field is configured. Additional keys: not allowed
api_name	string	Required within parent	API name of the field used as the sort column in this view. Maximum 50 characters. Maximum length: 50
id	string	Required within parent	Unique numeric identifier (as string) of the field used as the sort column in this view. Format: int64

Get module metadata by API name — response body — modules / modules / item / custom_view / access_type: shared, public, only to me, category: created by me, shared with me, public views sort by api name, id — shared_sort-by_9fe373614add

Field	Type	Presence	Description and constraints
$	null	Root	Field object specifying the column used to sort records in this view, containing api_name and id. Null when no sort field is configured. Additional keys: not allowed
api_name	string	Required within parent	API name of the field used as the sort column in this view. Maximum 50 characters. Maximum length: 50
id	string	Required within parent	Unique numeric identifier (as string) of the field used as the sort column in this view. Format: int64

Policy, approvals and errors

SDK function policy ID: zoho.getmodulebyapiname. Catalog operation: getModuleByApiName. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source