> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Zoho CRM: README
> Retrieve related lists configuration. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
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.
```ts theme={null}
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
```bash theme={null}
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`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Get the configuration of related lists for a specific module and layout",
"properties": {
"module": {
"type": "string",
"description": "API name of the CRM module (e.g., Leads, Contacts, Accounts)",
"enum": [
"Leads",
"Contacts",
"Accounts",
"Deals",
"Tasks",
"Events",
"Calls",
"Products",
"Quotes",
"Sales_Orders",
"Purchase_Orders",
"Invoices",
"Campaigns",
"Vendors",
"Price_Books",
"Cases",
"Solutions"
]
},
"layout_id": {
"type": "string",
"description": "Unique identifier of the layout for which to retrieve related lists",
"minLength": 1,
"maxLength": 20,
"pattern": "^[0-9]+$"
},
"status": {
"type": "string",
"description": "Filter related lists by visibility status",
"enum": [
"visible",
"scheduled_for_deletion",
"user_hidden"
]
}
},
"required": [
"module"
],
"additionalProperties": false
}
```
## 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). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Response containing related lists configuration for the specified module",
"properties": {
"related_lists": {
"type": "array",
"description": "Array of related list configurations",
"minItems": 0,
"maxItems": 2147483647,
"items": {
"type": "object",
"description": "Configuration metadata for a related list.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the related list configuration.",
"minLength": 1,
"maxLength": 20,
"pattern": "^[0-9]+$"
},
"sequence_number": {
"type": "string",
"description": "Display order position of the related list in the layout.",
"minLength": 1,
"maxLength": 10,
"pattern": "^[0-9]+$"
},
"display_label": {
"type": "string",
"description": "User-friendly label displayed for the related list.",
"minLength": 1,
"maxLength": 100
},
"api_name": {
"type": "string",
"description": "API name identifier for the related list module.",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9_]+$"
},
"module": {
"type": "object",
"description": "Module information for the related list (null if not applicable).",
"additionalProperties": true
},
"name": {
"type": "string",
"description": "Internal name of the related list.",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9_ -]+$"
},
"action": {
"type": [
"string",
"null"
],
"description": "Action key of the related list (null if no specific action).",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_]+$"
},
"href": {
"type": [
"string",
"null"
],
"description": "Reference URL for the related list (null if not applicable).",
"minLength": 1,
"maxLength": 2048
},
"type": {
"type": "string",
"description": "Type classification of the related list.",
"minLength": 1,
"maxLength": 64,
"pattern": "^[A-Za-z0-9_]+$"
},
"connectedlookupApiName": {
"type": "string",
"description": "API name of the connected lookup field if applicable.",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9_]+$"
},
"field_enabled": {
"type": "boolean",
"description": "Whether field customization is enabled for this related list."
},
"customize_sort": {
"type": "boolean",
"description": "Whether custom sorting can be applied to this related list."
},
"customize_fields": {
"type": "boolean",
"description": "Whether field selection can be customized for this related list."
},
"customize_display_label": {
"type": "boolean",
"description": "Whether the display label can be customized for this related list."
},
"status": {
"type": "string",
"description": "The visibility status of the related list.",
"enum": [
"visible",
"user_hidden",
"scheduled_for_deletion"
]
},
"visibility": {
"type": "integer",
"description": "Visibility level setting for the related list.",
"minimum": 0,
"format": "int32"
},
"personality_name": {
"type": "string",
"description": "Name of the personality associated with the related list.",
"minLength": 1,
"maxLength": 100
},
"record_operations": {
"type": "object",
"description": "Flags indicating the record operations allowed on the related list.",
"properties": {
"edit": {
"type": "boolean",
"description": "Whether edit operation is allowed on related list records."
},
"create": {
"type": "boolean",
"description": "Whether create operation is allowed on related list records."
},
"bulk_edit": {
"type": "boolean",
"description": "Whether bulk edit operation is allowed on related list records."
},
"delete": {
"type": "boolean",
"description": "Whether delete operation is allowed on related list records."
},
"disassociate": {
"type": "boolean",
"description": "Whether disassociate operation is allowed on related list records."
},
"assign": {
"type": "boolean",
"description": "Whether assign operation is allowed on related list records."
}
},
"required": [
"edit",
"create",
"bulk_edit",
"delete",
"disassociate",
"assign"
],
"additionalProperties": false
},
"connectedmodule": {
"type": [
"string",
"null"
],
"description": "The connected module name (null if no module connection).",
"minLength": 1,
"maxLength": 250,
"pattern": "^[A-Za-z0-9_]+$"
},
"linkingmodule": {
"type": [
"string",
"null"
],
"description": "The linking module name (null if no linking module).",
"minLength": 1,
"maxLength": 250,
"pattern": "^[A-Za-z0-9_]+$"
},
"parent_related_lists": {
"type": [
"array",
"null"
],
"description": "Array of parent related lists that this list depends on.",
"minItems": 0,
"maxItems": 2147483647,
"items": {
"type": "object",
"description": "Parent related list reference required for contextual dependencies.",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the parent related list.",
"minLength": 1,
"maxLength": 100,
"pattern": "^[A-Za-z0-9_]+$"
},
"id": {
"type": "string",
"description": "Unique identifier of the parent related list.",
"minLength": 1,
"maxLength": 20,
"pattern": "^[0-9]+$"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
}
}
},
"required": [
"id",
"sequence_number",
"display_label",
"api_name",
"name",
"action",
"href",
"type",
"customize_sort",
"customize_fields",
"customize_display_label",
"status"
],
"additionalProperties": false
}
}
},
"required": [
"related_lists"
],
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Deepline cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
## Related documentation
* [SDK V2 quickstart](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)