> ## 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
> List Related Records. Zoho CRM Related Records Get Related Records reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline.
List Related Records.
Tool ID: `zoho_crm_related_records_get_related_records`
## 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:
```bash theme={null}
deepline tools get zoho_crm_related_records_get_related_records --json
```
## Example response
The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_related_records_get_related_records --json` for the complete live contract.
## Input reference
Retrieves a paginated list of records from a specific related list of a parent record in a CRM module. Supports filtering by fields and conditional requests using If-Modified-Since header.
| Name | Type | Required | Default | Details |
| ---------------------------- | ------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.parentRecordModule` | `string` | Yes | — | The module name of the parent record (e.g., Contacts, Leads, Deals, Accounts, Services\_\_s, Price\_Books) Maximum length: 100. Pattern: `^[A-Za-z_][A-Za-z0-9_]*$`. |
| `payload.parentRecord` | `string` | Yes | — | The unique identifier of the parent record. Must be a valid numeric record ID. Maximum length: 20. Pattern: `^[0-9]+$`. |
| `payload.relatedList` | `string` | Yes | — | The name of the related list (module) containing the records to retrieve or modify Maximum length: 100. Pattern: `^[A-Za-z_][A-Za-z0-9_]*$`. |
| `payload.fields` | `string` | Yes | — | Comma-separated list of field names to include in the response. Field names must follow API naming conventions. Maximum length: 1000. Pattern: `^[A-Za-z_][A-Za-z0-9_]*(,[A-Za-z_][A-Za-z0-9_]*)*$`. |
| `payload.page` | `integer` | No | — | Page number for pagination (starting from 1) Format: `int32`. Minimum: 1. Maximum: 10000. |
| `payload.perPage` | `integer` | No | — | Number of records to return per page Format: `int32`. Minimum: 1. Maximum: 200. |
| `payload.page_token` | `string` | No | — | Token for fetching the next set of records after 2000. Use the value from 'next\_page\_token' in the previous response. Maximum length: 500. |
| `payload.ids` | `string` | No | — | Comma-separated list of record IDs to retrieve. Maximum length: 2000. Pattern: `^[0-9]+(,[0-9]+)*$`. |
| `payload.sort_order` | `"asc" \| "desc"` | No | — | Sort order for records. Allowed: `asc`, `desc`. |
| `payload.sort_by` | `"id" \| "Created_Time" \| "Modified_Time"` | No | — | Field to sort records by. Allowed: id, Created\_Time, Modified\_Time. Allowed: `id`, `Created_Time`, `Modified_Time`. |
| `payload.converted` | `"true" \| "false" \| "both"` | No | — | Filter for converted records. Allowed: `true`, `false`, `both`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Retrieves a paginated list of records from a specific related list of a parent record in a CRM module. Supports filtering by fields and conditional requests using If-Modified-Since header.",
"properties": {
"parentRecordModule": {
"type": "string",
"description": "The module name of the parent record (e.g., Contacts, Leads, Deals, Accounts, Services__s, Price_Books)",
"maxLength": 100,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"parentRecord": {
"type": "string",
"description": "The unique identifier of the parent record. Must be a valid numeric record ID.",
"maxLength": 20,
"pattern": "^[0-9]+$"
},
"relatedList": {
"type": "string",
"description": "The name of the related list (module) containing the records to retrieve or modify",
"maxLength": 100,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*$"
},
"fields": {
"type": "string",
"description": "Comma-separated list of field names to include in the response. Field names must follow API naming conventions.",
"maxLength": 1000,
"pattern": "^[A-Za-z_][A-Za-z0-9_]*(,[A-Za-z_][A-Za-z0-9_]*)*$"
},
"page": {
"type": "integer",
"description": "Page number for pagination (starting from 1)",
"minimum": 1,
"maximum": 10000,
"format": "int32"
},
"perPage": {
"type": "integer",
"description": "Number of records to return per page",
"minimum": 1,
"maximum": 200,
"format": "int32"
},
"page_token": {
"type": "string",
"description": "Token for fetching the next set of records after 2000. Use the value from 'next_page_token' in the previous response.",
"maxLength": 500
},
"ids": {
"type": "string",
"description": "Comma-separated list of record IDs to retrieve.",
"maxLength": 2000,
"pattern": "^[0-9]+(,[0-9]+)*$"
},
"sort_order": {
"type": "string",
"description": "Sort order for records.",
"enum": [
"asc",
"desc"
]
},
"sort_by": {
"type": "string",
"description": "Field to sort records by. Allowed: id, Created_Time, Modified_Time.",
"enum": [
"id",
"Created_Time",
"Modified_Time"
]
},
"converted": {
"type": "string",
"description": "Filter for converted records.",
"enum": [
"true",
"false",
"both"
]
}
},
"required": [
"parentRecordModule",
"parentRecord",
"relatedList",
"fields"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| -------------------------------------- | ---------------- | -------- | ------- | --------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Response containing related records data with pagination metadata |
| `result.data.data` | `array` | Yes | — | Array of related record objects with requested fields Maximum items: 200. |
| `result.data.data[].id` | `string` | No | — | Unique identifier of the related record Maximum length: 20. Pattern: `^[0-9]+$`. |
| `result.data.data[].Created_Time` | `string` | No | — | Timestamp when the record was created Format: `date-time`. |
| `result.data.data[].Modified_Time` | `string` | No | — | Timestamp when the record was last modified Format: `date-time`. |
| `result.data.data[].Moved_To__s` | `string` | No | — | Stage value to which the record was moved (stage history / picklist movement). Maximum length: 255. |
| `result.data.info` | `object` | Yes | — | Pagination and response metadata |
| `result.data.info.page` | `integer` | Yes | — | Current page number Format: `int32`. Minimum: 1. |
| `result.data.info.per_page` | `integer` | Yes | — | Number of records per page Format: `int32`. Minimum: 1. Maximum: 200. |
| `result.data.info.count` | `integer` | Yes | — | Number of records in current response Format: `int32`. Minimum: 0. |
| `result.data.info.more_records` | `boolean` | Yes | — | Indicates if more pages are available |
| `result.data.info.next_page_token` | `string \| null` | No | — | Token to retrieve the next page of results Maximum length: 500. |
| `result.data.info.page_token_expiry` | `string \| null` | No | — | Expiration timestamp for the page token Format: `date-time`. |
| `result.data.info.previous_page_token` | `string \| null` | No | — | Token to retrieve the previous page of results Maximum length: 500. |
| `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 records data with pagination metadata",
"properties": {
"data": {
"type": "array",
"description": "Array of related record objects with requested fields",
"maxItems": 200,
"items": {
"type": "object",
"description": "Individual related record with dynamic CRM fields",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the related record",
"maxLength": 20,
"pattern": "^[0-9]+$"
},
"Created_Time": {
"type": "string",
"description": "Timestamp when the record was created",
"format": "date-time"
},
"Modified_Time": {
"type": "string",
"description": "Timestamp when the record was last modified",
"format": "date-time"
},
"Moved_To__s": {
"type": "string",
"description": "Stage value to which the record was moved (stage history / picklist movement).",
"maxLength": 255
}
},
"additionalProperties": true
}
},
"info": {
"type": "object",
"description": "Pagination and response metadata",
"properties": {
"page": {
"type": "integer",
"description": "Current page number",
"minimum": 1,
"format": "int32"
},
"per_page": {
"type": "integer",
"description": "Number of records per page",
"minimum": 1,
"maximum": 200,
"format": "int32"
},
"count": {
"type": "integer",
"description": "Number of records in current response",
"minimum": 0,
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more pages are available"
},
"next_page_token": {
"type": [
"string",
"null"
],
"description": "Token to retrieve the next page of results",
"maxLength": 500
},
"page_token_expiry": {
"type": [
"string",
"null"
],
"description": "Expiration timestamp for the page token",
"format": "date-time"
},
"previous_page_token": {
"type": [
"string",
"null"
],
"description": "Token to retrieve the previous page of results",
"maxLength": 500
}
},
"required": [
"page",
"per_page",
"count",
"more_records"
],
"additionalProperties": false
}
},
"required": [
"data",
"info"
],
"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)