> ## 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 Notes. Zoho CRM Notes Get Notes Module reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.
Get Notes.
Tool ID: `zoho_crm_notes_get_notes_module`
## 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_notes_get_notes_module',
{
"fields": "example",
"ids": "example",
"per_page": 123
},
);
console.log(result.toolResponse.raw);
```
### CLI
```bash theme={null}
deepline tools execute zoho_crm_notes_get_notes_module --input '{
"fields": "example",
"ids": "example",
"per_page": 123
}' --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,
"per_page": 123,
"count": 123,
"more_records": true
}
}
}
```
Use `deepline tools get zoho_crm_notes_get_notes_module --json` for the latest machine-readable contract.
## Input reference
Retrieves a list of notes.
| Name | Type | Required | Default | Details |
| -------------------- | ------------------------------------------- | -------- | ------- | ---------------------------------------------------------------------------------------- |
| `payload.fields` | `string` | No | — | Comma-separated list of field API names to include in the response Maximum length: 1024. |
| `payload.ids` | `string` | No | — | Comma-separated list of note IDs to retrieve specific notes Maximum length: 1024. |
| `payload.per_page` | `integer` | No | — | Number of records per page Format: `int32`. |
| `payload.page` | `integer` | No | — | Page number for pagination Format: `int32`. |
| `payload.page_token` | `string` | No | — | Page token for fetching more than 2000 records Maximum length: 2000. |
| `payload.sort_order` | `"asc" \| "desc"` | No | — | Sort order (ascending or descending) Allowed: `asc`, `desc`. |
| `payload.sort_by` | `"Modified_Time" \| "Created_Time" \| "id"` | No | — | Field name to sort results by Allowed: `Modified_Time`, `Created_Time`, `id`. |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Retrieves a list of notes.",
"properties": {
"fields": {
"type": "string",
"description": "Comma-separated list of field API names to include in the response",
"maxLength": 1024
},
"ids": {
"type": "string",
"description": "Comma-separated list of note IDs to retrieve specific notes",
"maxLength": 1024
},
"per_page": {
"type": "integer",
"description": "Number of records per page",
"format": "int32"
},
"page": {
"type": "integer",
"description": "Page number for pagination",
"format": "int32"
},
"page_token": {
"type": "string",
"description": "Page token for fetching more than 2000 records",
"maxLength": 2000
},
"sort_order": {
"type": "string",
"description": "Sort order (ascending or descending)",
"enum": [
"asc",
"desc"
]
},
"sort_by": {
"type": "string",
"description": "Field name to sort results by",
"enum": [
"Modified_Time",
"Created_Time",
"id"
]
}
},
"required": [],
"additionalProperties": false
}
```
## Output reference
Standard tool result payload.
| Name | Type | Required | Default | Details |
| ---------------------------------------------- | ----------------- | -------- | ------- | -------------------------------------------------------------- |
| `result.data` | `object` | Yes | — | Response containing note data and pagination information |
| `result.data.data` | `array` | Yes | — | Array of note records Maximum items: 200. |
| `result.data.data[].id` | `string` | Yes | — | Unique identifier of the note Format: `int64`. |
| `result.data.data[].Note_Title` | `string \| null` | No | — | The title of the note Maximum length: 120. |
| `result.data.data[].Note_Content` | `string \| null` | No | — | The content/body of the note Maximum length: 65535. |
| `result.data.data[].$attachments` | `array \| null` | No | — | Attachments associated with the note Maximum items: 5. |
| `result.data.data[].$attachments[].$file_id` | `string` | No | — | Unique file identifier for the attachment Maximum length: 255. |
| `result.data.data[].$attachments[].File_Name` | `string` | No | — | Name of the attached file Maximum length: 255. |
| `result.data.data[].$attachments[].Size` | `string` | No | — | File size in bytes Format: `int64`. |
| `result.data.data[].$attachments[].id` | `string` | No | — | Unique identifier of the attachment record Format: `int64`. |
| `result.data.data[].Parent_Id` | `object` | No | — | Parent record information |
| `result.data.data[].Parent_Id.module` | `object` | Yes | — | Module information of the parent record |
| `result.data.data[].Parent_Id.module.api_name` | `string` | Yes | — | API name of the parent module Maximum length: 50. |
| `result.data.data[].Parent_Id.module.id` | `string` | Yes | — | Module ID Format: `int64`. |
| `result.data.data[].Parent_Id.name` | `string` | Yes | — | Name of the parent record Maximum length: 255. |
| `result.data.data[].Parent_Id.id` | `string` | Yes | — | Unique identifier of the parent record Format: `int64`. |
| `result.data.info` | `object` | Yes | — | Pagination metadata |
| `result.data.info.page` | `integer` | Yes | — | Current page number Format: `int32`. |
| `result.data.info.per_page` | `integer` | Yes | — | Number of records per page Format: `int32`. |
| `result.data.info.count` | `integer` | Yes | — | Number of records in current page Format: `int32`. |
| `result.data.info.more_records` | `boolean` | Yes | — | Indicates if more records are available |
| `result.data.info.next_page_token` | `string \| null` | No | — | Token for fetching the next page Maximum length: 2000. |
| `result.data.info.previous_page_token` | `string \| null` | No | — | Token for fetching the previous page Maximum length: 2000. |
| `result.data.info.page_token_expiry` | `string \| null` | No | — | Expiry time of page tokens Format: `date-time`. |
| `result.data.info.sort_by` | `string` | No | — | Field by which the results are sorted Maximum length: 50. |
| `result.data.info.sort_order` | `"asc" \| "desc"` | No | — | Sort order of the results Allowed: `asc`, `desc`. |
| `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 note data and pagination information",
"properties": {
"data": {
"type": "array",
"description": "Array of note records",
"maxItems": 200,
"items": {
"type": "object",
"description": "A note record with static fields and dynamic additional properties",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier of the note",
"format": "int64"
},
"Note_Title": {
"type": [
"string",
"null"
],
"description": "The title of the note",
"maxLength": 120
},
"Note_Content": {
"type": [
"string",
"null"
],
"description": "The content/body of the note",
"maxLength": 65535
},
"$attachments": {
"type": [
"array",
"null"
],
"description": "Attachments associated with the note",
"maxItems": 5,
"items": {
"type": "object",
"description": "Attachment file details",
"properties": {
"$file_id": {
"type": "string",
"description": "Unique file identifier for the attachment",
"maxLength": 255
},
"File_Name": {
"type": "string",
"description": "Name of the attached file",
"maxLength": 255
},
"Size": {
"type": "string",
"description": "File size in bytes",
"format": "int64"
},
"id": {
"type": "string",
"description": "Unique identifier of the attachment record",
"format": "int64"
}
},
"additionalProperties": true
}
},
"Parent_Id": {
"type": "object",
"description": "Parent record information",
"properties": {
"module": {
"type": "object",
"description": "Module information of the parent record",
"properties": {
"api_name": {
"type": "string",
"description": "API name of the parent module",
"maxLength": 50
},
"id": {
"type": "string",
"description": "Module ID",
"format": "int64"
}
},
"required": [
"api_name",
"id"
],
"additionalProperties": false
},
"name": {
"type": "string",
"description": "Name of the parent record",
"maxLength": 255
},
"id": {
"type": "string",
"description": "Unique identifier of the parent record",
"format": "int64"
}
},
"required": [
"module",
"id",
"name"
],
"additionalProperties": false
}
},
"required": [
"id"
],
"additionalProperties": true
}
},
"info": {
"type": "object",
"description": "Pagination metadata",
"properties": {
"page": {
"type": "integer",
"description": "Current page number",
"format": "int32"
},
"per_page": {
"type": "integer",
"description": "Number of records per page",
"format": "int32"
},
"count": {
"type": "integer",
"description": "Number of records in current page",
"format": "int32"
},
"more_records": {
"type": "boolean",
"description": "Indicates if more records are available"
},
"next_page_token": {
"type": [
"string",
"null"
],
"description": "Token for fetching the next page",
"maxLength": 2000
},
"previous_page_token": {
"type": [
"string",
"null"
],
"description": "Token for fetching the previous page",
"maxLength": 2000
},
"page_token_expiry": {
"type": [
"string",
"null"
],
"description": "Expiry time of page tokens",
"format": "date-time"
},
"sort_by": {
"type": "string",
"description": "Field by which the results are sorted",
"maxLength": 50
},
"sort_order": {
"type": "string",
"description": "Sort order of the results",
"enum": [
"asc",
"desc"
]
}
},
"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)