Zoho CRM: README

Get a specific layout metadata by ID.

Tool ID: zoho_crm_layouts_get_layout_by_id

Run this action

This action has conditional or dynamic input fields that cannot be represented by a reliable static example. Inspect the live contract before executing it:

deepline tools get zoho_crm_layouts_get_layout_by_id --json

Example response

The static output schema is not detailed enough to generate a reliable example. Use deepline tools get zoho_crm_layouts_get_layout_by_id --json for the complete live contract.

Input reference

Retrieves comprehensive details of a specific layout by its unique identifier for a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions. Important Notes: - The profiles array will be null if the user does not have “Module Customization” permission in their profile. - For Deals module: When the pipeline feature is enabled, multiple layouts exist per pipeline. Each pipeline can have its own set of layouts. - The mode parameter supports different values based on module type. Common modes include business_card and quick_create. - Score and Visit Summary sections are system-generated and read-only. Prerequisite: The Layout ID can be obtained from the Get All Layouts API.

Name	Type	Required	Default	Details
`payload.id`	`string`	Yes	—	Unique identifier of the layout. Must be a valid 64-bit integer represented as a string. Can be obtained from the Get Layouts API. Format: `int64`. Minimum length: 1. Maximum length: 19. Pattern: `^[0-9]{1,19}$`.
`payload.module`	`string`	Yes	—	Specify the API name of the required module. Supports both standard modules (Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price_Books, Quotes, Sales_Orders, Purchase_Orders, Invoices, Appointments, Services) and custom modules. Module API names are case-insensitive, can contain alphanumeric characters and underscores, must not contain spaces, and have a maximum length of 50 characters. Use the GET - Modules Metadata API to retrieve all See the live schema for the complete constraint.
`payload.mode`	`"all" \| "business_card" \| "quick_create"`	No	—	Filter layouts by mode. Available modes vary by module type: - `business_card`: Business card layout view - `quick_create`: Quick create form layout - `all`: Request all available modes If not provided, the default mode for the module will be applied. Note: Mode availability depends on the module and its configuration. Allowed: `all`, `business_card`, `quick_create`.
`payload.include`	`"total_profiles" \| "portal_user_types"`	No	—	Specifies additional data to include in the response. Allowed: `total_profiles`, `portal_user_types`.
`payload.include_inner_details`	`string`	No	—	Specifies additional inner details to include in the response. Accepts a comma-separated list of dot-notation paths indicating which nested properties should return extended information. Maximum length: 255. Pattern: `^[a-z_]+(\.[a-z_]+)?(,[a-z_]+(\.[a-z_]+)?)*$`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`unknown`	Yes	—	Provider response payload.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

Getting Started

GTM is code

Features

Deepline SDK beta

Integrations

API Reference

Run this action

Example response

Input reference

Output reference

Deepline cost

​Run this action

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

Example response

Input reference

Output reference

Deepline cost

Related documentation