Zoho: Related Lists
Zoho relatedLists.getRelatedLists: arguments, response, policy and SDK examples.
← Related lists operations · Get started
Operation zoho.getrelatedlists
Provider route: GET /crm/v8/settings/related_lists. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["relatedLists"]["getRelatedLists"]>[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.relatedLists.getRelatedLists(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.related_lists.get_related_lists(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Required within parent | Additional keys: not allowed |
query.module | string | Required within parent | Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z][A-Za-z0-9_]*$ |
query.layout_id | string | Optional | Format: int64 |
query.status | string | Optional | One of: visible, scheduled_for_deletion, user_hidden |
query.extra_properties | boolean | Optional | Default: false |
query.include_inner_details | string | Optional | Maximum length: 255 Minimum length: 1 |
Response
Section titled “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 | Response containing the related list configurations for the specified module. Additional keys: not allowed |
$ (anyOf 1).related_lists | array | Required within parent | Array of related list configurations for the specified module and layout. Maximum items: 1000 Minimum items: 1 |
$ (anyOf 1).related_lists[] | Model | Each item | Expand Related Lists — response body — related lists related lists item |
$ (anyOf 2) | null | Alternative |
Referenced models: Related Lists — response body — related lists related lists item
Schemas
Section titled “Schemas”15 more schemas are linked from the tables above, on the schema pages.
Related Lists — response body — related lists related lists item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the base configuration metadata for a related list panel in a CRM module. |
$ (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup |
$ (anyOf 2) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion, type: multiselectlookup, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion
Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Configuration metadata for a standard (non-multiselectlookup) related list. Additional keys: not allowed |
_layout_specific_properties | JSON | Optional | |
_layout_specific_properties (anyOf 1) | array | Alternative | Layout-specific configuration overrides for this related list. Maximum items: 25 Minimum items: 0 |
_layout_specific_properties (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item |
_layout_specific_properties (anyOf 2) | null | Alternative | Layout-specific configuration overrides for this related list. Maximum items: 25 Minimum items: 0 |
_layout_specific_properties (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item |
action | JSON | Required within parent | |
action (anyOf 1) | string | Alternative | Action type supported for adding records to the related list. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
action (anyOf 2) | null | Alternative | Action type supported for adding records to the related list. Maximum length: 50 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
api_name | string | Required within parent | API name identifier for the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedlookupApiName | string | Optional | API name of the connected lookup field for this related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedmodule | JSON | Optional | |
connectedmodule (anyOf 1) | string | Alternative | API name of the connected module for this lookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
connectedmodule (anyOf 2) | null | Alternative | API name of the connected module for this lookup relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
customize_display_label | boolean | Required within parent | Indicates whether the display label of this related list can be customized. Possible values: **true**, **false**. |
customize_fields | boolean | Required within parent | Indicates whether the field selection for this related list can be customized. Possible values: **true**, **false**. |
customize_sort | boolean | Required within parent | Indicates whether the sort configuration for this related list can be customized. Possible values: **true**, **false**. |
display_label | string | Required within parent | User-visible label displayed for the related list panel. Maximum length: 50 Minimum length: 1 |
fields | JSON | Optional | |
fields (anyOf 1) | array | Alternative | Fields displayed in the related list (null if not configured). Maximum items: 50 Minimum items: 0 |
fields (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item |
fields (anyOf 2) | null | Alternative | Fields displayed in the related list (null if not configured). Maximum items: 50 Minimum items: 0 |
fields (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item |
href | JSON | Required within parent | |
href (anyOf 1) | string | Alternative | Relative URL template for navigating to the related list records. Maximum length: 200 Minimum length: 1 |
href (anyOf 2) | null | Alternative | Relative URL template for navigating to the related list records. Maximum length: 200 Minimum length: 1 |
id | string | Required within parent | Unique identifier of the related list configuration. Format: int64 |
linkingmodule | JSON | Optional | |
linkingmodule (anyOf 1) | string | Alternative | API name of the linking module for this relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
linkingmodule (anyOf 2) | null | Alternative | API name of the linking module for this relationship. Maximum length: 250 Minimum length: 1 Pattern: ^[A-Za-z0-9_]+$ |
module | JSON | Required within parent | Module information for the related list. Refer to the [Get Modules](https://www.zoho.com/crm/developer/docs/api/v8/modules-api.html) resource for details. |
module (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label |
module (anyOf 2) | null | Alternative | Represents the null state when no module is associated with this related list. |
name | string | Required within parent | Internal name of the related list. Maximum length: 100 Minimum length: 1 Pattern: ^[A-Za-z0-9_ \-]+$ |
parent_related_lists | JSON | Optional | |
parent_related_lists (anyOf 1) | array | Alternative | List of parent related list references that this related list depends on. Maximum items: 4 Minimum items: 0 |
parent_related_lists (anyOf 1)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item |
parent_related_lists (anyOf 2) | null | Alternative | List of parent related list references that this related list depends on. Maximum items: 4 Minimum items: 0 |
parent_related_lists (anyOf 2)[] | Model | Each item | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item |
personality_name | string | Optional | Internal personality identifier associated with this related list configuration. Maximum length: 100 Minimum length: 1 |
record_operations | Model | Optional | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations |
sequence_number | string | Required within parent | Display sequence position of the related list in the layout. Format: int32 |
sort_by | JSON | Optional | Field used for sorting the related list (null if no sorting configured). |
sort_by (anyOf 1) | Model | Alternative | Expand Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion sort by api name, id |
sort_by (anyOf 2) | null | Alternative | No sorting is applied. |
sort_order | JSON | Optional | |
sort_order (anyOf 1) | string | Alternative | Sort direction applied to the related list (null if no sorting configured). Known values: asc, desc |
sort_order (anyOf 2) | null | Alternative | Sort direction applied to the related list (null if no sorting configured). Known values: asc, desc |
status | string | Required within parent | Visibility status of the related list. Possible values: **visible**, **user_hidden**, **scheduled_for_deletion**. Known values: visible, user_hidden, scheduled_for_deletion |
type | string | Required within parent | Relationship type of the related list. Known values: default, custom, custom_lookup, custom_related_list, queries, grouped, combined_view, slyteui |
visibility | JSON | Optional | |
visibility (anyOf 1) | integer | Alternative | Numeric visibility flag for the related list. Format: int32 Minimum: 0 |
visibility (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion fields null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion layout specific properties null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion module api name, id, plural label, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion parent related lists null item, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion record operations, Related Lists — response body — related_lists / related_lists / item / status: visible, user hidden, scheduled for deletion sort by api name, id
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getrelatedlists. Catalog operation: getRelatedLists. 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]