> ## 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: Notes Get Note By ID

> Get one Zoho CRM note by its ID, with its title, content and parent record. Includes SDK V2 examples, input constraints, response fields, and Deepline cost.

Get one Zoho CRM note by its ID, with its title, content and parent record.

> [!NOTE]
>
> Tool ID: `zoho_crm_notes_get_note_by_id`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_notes_get_note_by_id',
  {
    "id": "id_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_notes_get_note_by_id --input '{
  "id": "id_123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data": [
      {
        "id": "id_123"
      }
    ]
  }
}
```

Use `deepline describe zoho_crm_notes_get_note_by_id --json` for the latest machine-readable contract.

## Input reference

Retrieves details of a specific note by its ID.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.id` | `string` | Yes | — | Unique identifier of the note Format: `int64`. |
| `payload.fields` | `string` | No | — | Comma-separated list of field API names to include in the response Maximum length: 1024. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieves details of a specific note by its ID.",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier of the note",
        "format": "int64"
      },
      "fields": {
        "type": "string",
        "description": "Comma-separated list of field API names to include in the response",
        "maxLength": 1024
      }
    },
    "required": [
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response containing a single note |
| `result.data.data` | `array` | Yes | — | Array containing the single requested note Maximum items: 1. |
| `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` | 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.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response containing a single note",
        "properties": {
          "data": {
            "type": "array",
            "description": "Array containing the single requested note",
            "maxItems": 1,
            "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",
                  "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
            }
          }
        },
        "required": [
          "data"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.