Zoho: Get a Specific Note

← Notes operations · Get started

Operation zoho.getnotebyid

Provider route: GET /crm/v8/Notes/{id}. Alter supplies the connection’s credentials and routing.

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["notes"]["getNoteById"]>[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.notes.getNoteById(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from 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.notes.get_note_by_id(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent	Format: int64
query	object	Optional	Additional keys: not allowed
query.fields	string	Optional	Maximum length: 1024

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 a single note Additional keys: not allowed
$ (anyOf 1).data	array	Required within parent	Array containing the single requested note Maximum items: 1
$ (anyOf 1).data[]	object	Each item	A note record with static fields and dynamic additional properties Additional keys: allowed
$ (anyOf 1).data[].$attachments	JSON	Optional
$ (anyOf 1).data[].$attachments (anyOf 1)	array	Alternative	Attachments associated with the note Maximum items: 5
$ (anyOf 1).data[].$attachments (anyOf 1)[]	object	Each item	Attachment file details Additional keys: allowed
$ (anyOf 1).data[].$attachments (anyOf 1)[].$file_id	string	Optional	Unique file identifier for the attachment Maximum length: 255
$ (anyOf 1).data[].$attachments (anyOf 1)[].File_Name	string	Optional	Name of the attached file Maximum length: 255
$ (anyOf 1).data[].$attachments (anyOf 1)[].Size	string	Optional	File size in bytes Format: int64
$ (anyOf 1).data[].$attachments (anyOf 1)[].id	string	Optional	Unique identifier of the attachment record Format: int64
$ (anyOf 1).data[].$attachments (anyOf 2)	null	Alternative	Attachments associated with the note Maximum items: 5
$ (anyOf 1).data[].$attachments (anyOf 2)[]	object	Each item	Attachment file details Additional keys: allowed
$ (anyOf 1).data[].$attachments (anyOf 2)[].$file_id	string	Optional	Unique file identifier for the attachment Maximum length: 255
$ (anyOf 1).data[].$attachments (anyOf 2)[].File_Name	string	Optional	Name of the attached file Maximum length: 255
$ (anyOf 1).data[].$attachments (anyOf 2)[].Size	string	Optional	File size in bytes Format: int64
$ (anyOf 1).data[].$attachments (anyOf 2)[].id	string	Optional	Unique identifier of the attachment record Format: int64
$ (anyOf 1).data[].Note_Content	string	Optional	The content/body of the note Maximum length: 65535
$ (anyOf 1).data[].Note_Title	JSON	Optional
$ (anyOf 1).data[].Note_Title (anyOf 1)	string	Alternative	The title of the note Maximum length: 120
$ (anyOf 1).data[].Note_Title (anyOf 2)	null	Alternative	The title of the note Maximum length: 120
$ (anyOf 1).data[].Parent_Id	Model	Optional	Expand Notes — notes get Notes Module — response body — data, info data item Parent Id
$ (anyOf 1).data[].id	string	Required within parent	Unique identifier of the note Format: int64
$ (anyOf 2)	null	Alternative

Referenced models: Notes — notes get Notes Module — response body — data, info data item Parent Id

Schemas

Notes — notes get Notes Module — response body — data, info data item Parent Id

Field	Type	Presence	Description and constraints
$	object	Root	Parent record information Additional keys: not allowed
id	string	Required within parent	Unique identifier of the parent record Format: int64
module	object	Required within parent	Module information of the parent record Additional keys: not allowed
module.api_name	string	Required within parent	API name of the parent module Maximum length: 50
module.id	string	Required within parent	Module ID Format: int64
name	string	Required within parent	Name of the parent record Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getnotebyid. Catalog operation: getNoteById. 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]

Official provider source