Zoho CRM: README

Retrieve related lists configuration.

Tool ID: zoho_crm_related_lists_get_related_lists

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_related_lists_get_related_lists',
  {
    "module": "Leads"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_related_lists_get_related_lists --input '{
  "module": "Leads"
}' --json

Example response

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

Input reference

Get the configuration of related lists for a specific module and layout

Name	Type	Required	Default	Details
`payload.module`	`"Leads" \| "Contacts" \| "Accounts" \| "Deals" \| "Tasks" \| "Events" \| "Calls" \| "Products" \| "Quotes" \| "Sales_Orders" \| "Purchase_Orders" \| "Invoices" \| "Campaigns" \| "Vendors" \| "Price_Books" \| "Cases" \| "Solutions"`	Yes	—	API name of the CRM module (e.g., Leads, Contacts, Accounts) Allowed: `Leads`, `Contacts`, `Accounts`, `Deals`, `Tasks`, `Events`, `Calls`, `Products`, `Quotes`, `Sales_Orders`, `Purchase_Orders`, `Invoices`, `Campaigns`, `Vendors`, `Price_Books`, `Cases`, `Solutions`.
`payload.layout_id`	`string`	No	—	Unique identifier of the layout for which to retrieve related lists Minimum length: 1. Maximum length: 20. Pattern: `^[0-9]+$`.
`payload.status`	`"visible" \| "scheduled_for_deletion" \| "user_hidden"`	No	—	Filter related lists by visibility status Allowed: `visible`, `scheduled_for_deletion`, `user_hidden`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Response containing related lists configuration for the specified module
`result.data.related_lists`	`array`	Yes	—	Array of related list configurations Minimum items: 0. Maximum items: 2147483647.
`result.data.related_lists[].id`	`string`	Yes	—	Unique identifier of the related list configuration. Minimum length: 1. Maximum length: 20. Pattern: `^[0-9]+$`.
`result.data.related_lists[].sequence_number`	`string`	Yes	—	Display order position of the related list in the layout. Minimum length: 1. Maximum length: 10. Pattern: `^[0-9]+$`.
`result.data.related_lists[].display_label`	`string`	Yes	—	User-friendly label displayed for the related list. Minimum length: 1. Maximum length: 100.
`result.data.related_lists[].api_name`	`string`	Yes	—	API name identifier for the related list module. Minimum length: 1. Maximum length: 100. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].module`	`record`	No	—	Module information for the related list (null if not applicable).
`result.data.related_lists[].name`	`string`	Yes	—	Internal name of the related list. Minimum length: 1. Maximum length: 100. Pattern: `^[A-Za-z0-9_ -]+$`.
`result.data.related_lists[].action`	`string \| null`	Yes	—	Action key of the related list (null if no specific action). Minimum length: 1. Maximum length: 64. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].href`	`string \| null`	Yes	—	Reference URL for the related list (null if not applicable). Minimum length: 1. Maximum length: 2048.
`result.data.related_lists[].type`	`string`	Yes	—	Type classification of the related list. Minimum length: 1. Maximum length: 64. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].connectedlookupApiName`	`string`	No	—	API name of the connected lookup field if applicable. Minimum length: 1. Maximum length: 100. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].field_enabled`	`boolean`	No	—	Whether field customization is enabled for this related list.
`result.data.related_lists[].customize_sort`	`boolean`	Yes	—	Whether custom sorting can be applied to this related list.
`result.data.related_lists[].customize_fields`	`boolean`	Yes	—	Whether field selection can be customized for this related list.
`result.data.related_lists[].customize_display_label`	`boolean`	Yes	—	Whether the display label can be customized for this related list.
`result.data.related_lists[].status`	`"visible" \| "user_hidden" \| "scheduled_for_deletion"`	Yes	—	The visibility status of the related list. Allowed: `visible`, `user_hidden`, `scheduled_for_deletion`.
`result.data.related_lists[].visibility`	`integer`	No	—	Visibility level setting for the related list. Format: `int32`. Minimum: 0.
`result.data.related_lists[].personality_name`	`string`	No	—	Name of the personality associated with the related list. Minimum length: 1. Maximum length: 100.
`result.data.related_lists[].record_operations`	`object`	No	—	Flags indicating the record operations allowed on the related list.
`result.data.related_lists[].record_operations.edit`	`boolean`	Yes	—	Whether edit operation is allowed on related list records.
`result.data.related_lists[].record_operations.create`	`boolean`	Yes	—	Whether create operation is allowed on related list records.
`result.data.related_lists[].record_operations.bulk_edit`	`boolean`	Yes	—	Whether bulk edit operation is allowed on related list records.
`result.data.related_lists[].record_operations.delete`	`boolean`	Yes	—	Whether delete operation is allowed on related list records.
`result.data.related_lists[].record_operations.disassociate`	`boolean`	Yes	—	Whether disassociate operation is allowed on related list records.
`result.data.related_lists[].record_operations.assign`	`boolean`	Yes	—	Whether assign operation is allowed on related list records.
`result.data.related_lists[].connectedmodule`	`string \| null`	No	—	The connected module name (null if no module connection). Minimum length: 1. Maximum length: 250. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].linkingmodule`	`string \| null`	No	—	The linking module name (null if no linking module). Minimum length: 1. Maximum length: 250. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].parent_related_lists`	`array \| null`	No	—	Array of parent related lists that this list depends on. Minimum items: 0. Maximum items: 2147483647.
`result.data.related_lists[].parent_related_lists[].api_name`	`string`	Yes	—	API name of the parent related list. Minimum length: 1. Maximum length: 100. Pattern: `^[A-Za-z0-9_]+$`.
`result.data.related_lists[].parent_related_lists[].id`	`string`	Yes	—	Unique identifier of the parent related list. Minimum length: 1. Maximum length: 20. Pattern: `^[0-9]+$`.
`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

CLI

Example response

Input reference

Output reference

Deepline cost

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation