> ## 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
> Get Records for a specific module. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.
Get Records for a specific module.
Tool ID: `zoho_crm_record_get_records`
## 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_record_get_records',
{
"module": "example"
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_record_get_records --input '{
"module": "example"
}' --json
```
## Example response
The SDK exposes this shape at `result.toolResponse.raw`. Values below are representative.
```json theme={null}
{
"data": {
"data": [
{
"id": "id_123"
}
],
"info": {
"page": 123,
"call": true,
"per_page": 123
}
}
}
```
Use `deepline tools get zoho_crm_record_get_records --json` for the latest machine-readable contract.
## Input reference
To get the list of available records from a module
| Name | Type | Required | Default | Details |
| ----------------------- | ------------------------------------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `payload.module` | `string` | Yes | — | Specifies the module name Maximum length: 100. |
| `payload.fields` | `string` | No | — | Specify the API names of the fields you want to retrieve when fetching the records. Maximum length: 1024. |
| `payload.territory_id` | `string` | No | — | Specify the territory ID to get the list of records that belongs to a specific territory Format: `int64`. |
| `payload.ids` | `string` | No | — | To retrieve specific records based on their unique ID. Maximum length: 1024. |
| `payload.cvid` | `string` | No | — | Specify the custom view ID to get the list of records based on custom views Format: `int64`. |
| `payload.per_page` | `integer` | No | — | Specify how many records to return per page Format: `int32`. |
| `payload.page` | `integer` | No | — | To get the list of records from the respective pages Format: `int32`. |
| `payload.page_token` | `string` | No | — | To fetch more than 2000 records, you must include the "page\_token" param in the request Maximum length: 100. |
| `payload.sort_order` | `"desc" \| "asc"` | No | — | To sort the available list of records in either ascending or descending order Allowed: `desc`, `asc`. |
| `payload.sort_by` | `"id" \| "Created_Time" \| "Modified_Time"` | No | — | To sort the records based on the fields id, Created\_Time, and Modified\_Time. The default value is 'id' Allowed: `id`, `Created_Time`, `Modified_Time`. |
| `payload.converted` | `"false" \| "true" \| "both"` | No | — | To get the list of converted records Allowed: `false`, `true`, `both`. |
| `payload.include_child` | `boolean` | No | — | To include records from the child territories |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "To get the list of available records from a module",
"properties": {
"module": {
"type": "string",
"description": "Specifies the module name",
"maxLength": 100
},
"fields": {
"type": "string",
"description": "Specify the API names of the fields you want to retrieve when fetching the records.",
"maxLength": 1024
},
"territory_id": {
"type": "string",
"description": "Specify the territory ID to get the list of records that belongs to a specific territory",
"format": "int64"
},
"ids": {
"type": "string",
"description": "To retrieve specific records based on their unique ID.",
"maxLength": 1024
},
"cvid": {
"type": "string",
"description": "Specify the custom view ID to get the list of records based on custom views",
"format": "int64"
},
"per_page": {
"type": "integer",
"description": "Specify how many records to return per page",
"format": "int32"
},
"page": {
"type": "integer",
"description": "To get the list of records from the respective pages",
"format": "int32"
},
"page_token": {
"type": "string",
"description": "To fetch more than 2000 records, you must include the \"page_token\" param in the request",
"maxLength": 100
},
"sort_order": {
"type": "string",
"description": "To sort the available list of records in either ascending or descending order",
"enum": [
"desc",
"asc"
]
},
"sort_by": {
"type": "string",
"description": "To sort the records based on the fields id, Created_Time, and Modified_Time. The default value is 'id'",
"enum": [
"id",
"Created_Time",
"Modified_Time"
]
},
"converted": {
"type": "string",
"description": "To get the list of converted records",
"enum": [
"false",
"true",
"both"
]
},
"include_child": {
"type": "boolean",
"description": "To include records from the child territories"
}
},
"required": [
"module"
],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| -------------------------------------- | ----------------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Successful response schema returned for GET record or GET records API operations. |
| `result.data.data` | `array` | No | — | List of records retrieved from the module. Maximum items: 100. |
| `result.data.data[].id` | `string` | Yes | — | Unique identifier of the record. Format: `int64`. |
| `result.data.data[].Owner` | `object` | No | — | Details of the user who owns the record. |
| `result.data.data[].Owner.name` | `string` | No | — | Name of the record owner. Maximum length: 100. |
| `result.data.data[].Owner.id` | `string` | No | — | Unique identifier of the record owner. Format: `int64`. |
| `result.data.data[].Owner.email` | `string` | No | — | Email address of the record owner. Maximum length: 256. |
| `result.data.data[].Created_Time` | `string` | No | — | Timestamp indicating when the record was created. Format: `date-time`. |
| `result.data.data[].Modified_Time` | `string` | No | — | Timestamp indicating when the record was last modified. Format: `date-time`. |
| `result.data.data[].Created_By` | `object` | No | — | Details of the user who created the record. |
| `result.data.data[].Created_By.name` | `string` | No | — | Name of the user who created the record. Maximum length: 100. |
| `result.data.data[].Created_By.id` | `string` | No | — | Unique identifier of the user who created the record. Format: `int64`. |
| `result.data.data[].Modified_By` | `object` | No | — | Details of the user who last modified the record. |
| `result.data.data[].Modified_By.name` | `string` | No | — | Name of the user who last modified the record. Maximum length: 100. |
| `result.data.data[].Modified_By.id` | `string` | No | — | Unique identifier of the user who last modified the record. Format: `int64`. |
| `result.data.info` | `object` | No | — | Pagination and metadata information for the GET records response. |
| `result.data.info.page` | `integer` | No | — | Current page number. Format: `int32`. |
| `result.data.info.call` | `boolean` | No | — | Indicates whether call fields are included in the response. |
| `result.data.info.per_page` | `integer` | No | — | Number of records returned per page. Format: `int32`. |
| `result.data.info.count` | `integer` | No | — | Number of records returned in the current page. Format: `int32`. |
| `result.data.info.more_records` | `boolean` | No | — | Indicates whether more records are available for retrieval. |
| `result.data.info.email` | `boolean` | No | — | Indicates whether email-related fields are included in the response. |
| `result.data.info.sort_by` | `string` | No | — | Field name used to sort the records. Maximum length: 1024. |
| `result.data.info.sort_order` | `"asc" \| "desc"` | No | — | Sort order applied to the results (ascending or descending). Allowed: `asc`, `desc`. |
| `result.data.info.next_page_token` | `string` | No | — | Token used to fetch the next page of results. Maximum length: 1024. |
| `result.data.info.previous_page_token` | `string` | No | — | Token used to fetch the previous page of results. Maximum length: 1024. |
| `result.data.info.page_token_expiry` | `string` | No | — | Timestamp indicating when the page tokens will expire. Format: `date-time`. Maximum length: 1024. |
| `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": "Successful response schema returned for GET record or GET records API operations.",
"properties": {
"data": {
"type": "array",
"description": "List of records retrieved from the module.",
"maxItems": 100,
"items": {
"type": "object",
"description": "Represents a single record. This object may include both standard and custom fields.",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the record.",
"format": "int64"
},
"Owner": {
"type": "object",
"description": "Details of the user who owns the record.",
"properties": {
"name": {
"type": "string",
"description": "Name of the record owner.",
"maxLength": 100
},
"id": {
"type": "string",
"description": "Unique identifier of the record owner.",
"format": "int64"
},
"email": {
"type": "string",
"description": "Email address of the record owner.",
"maxLength": 256
}
},
"additionalProperties": false
},
"Created_Time": {
"type": "string",
"description": "Timestamp indicating when the record was created.",
"format": "date-time"
},
"Modified_Time": {
"type": "string",
"description": "Timestamp indicating when the record was last modified.",
"format": "date-time"
},
"Created_By": {
"type": "object",
"description": "Details of the user who created the record.",
"properties": {
"name": {
"type": "string",
"description": "Name of the user who created the record.",
"maxLength": 100
},
"id": {
"type": "string",
"description": "Unique identifier of the user who created the record.",
"format": "int64"
}
},
"additionalProperties": false
},
"Modified_By": {
"type": "object",
"description": "Details of the user who last modified the record.",
"properties": {
"name": {
"type": "string",
"description": "Name of the user who last modified the record.",
"maxLength": 100
},
"id": {
"type": "string",
"description": "Unique identifier of the user who last modified the record.",
"format": "int64"
}
},
"additionalProperties": false
}
},
"required": [
"id"
],
"additionalProperties": true
}
},
"info": {
"type": "object",
"description": "Pagination and metadata information for the GET records response.",
"properties": {
"page": {
"type": "integer",
"description": "Current page number.",
"format": "int32"
},
"call": {
"type": "boolean",
"description": "Indicates whether call fields are included in the response."
},
"per_page": {
"type": "integer",
"description": "Number of records returned per page.",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Number of records returned in the current page.",
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates whether more records are available for retrieval."
},
"email": {
"type": "boolean",
"description": "Indicates whether email-related fields are included in the response."
},
"sort_by": {
"type": "string",
"description": "Field name used to sort the records.",
"maxLength": 1024
},
"sort_order": {
"type": "string",
"description": "Sort order applied to the results (ascending or descending).",
"enum": [
"asc",
"desc"
]
},
"next_page_token": {
"type": "string",
"description": "Token used to fetch the next page of results.",
"maxLength": 1024
},
"previous_page_token": {
"type": "string",
"description": "Token used to fetch the previous page of results.",
"maxLength": 1024
},
"page_token_expiry": {
"type": "string",
"description": "Timestamp indicating when the page tokens will expire.",
"maxLength": 1024,
"format": "date-time"
}
},
"additionalProperties": false
}
},
"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)