Zoho: Related Notes — related Notes get Notes

Zoho relatedNotes.getNotes: arguments, response, policy and SDK examples.

Operation zoho.getnotes

Provider route: GET /crm/v8/{parentRecordModule}/{parentRecordId}/Notes. 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["relatedNotes"]["getNotes"]>[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.relatedNotes.getNotes(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.related_notes.get_notes(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.parentRecordModule`	string	Required within parent	Maximum length: 50 Pattern: ^[A-Za-z_][A-Za-z0-9_]*$
`path.parentRecordId`	string	Required within parent	Format: int64 Pattern: ^[0-9]+$
`query`	object	Optional	Additional keys: not allowed
`query.fields`	string	Optional	Maximum length: 1000 Pattern: ^[A-Za-z_][A-Za-z0-9_](,[A-Za-z_][A-Za-z0-9_])*$
`query.page`	integer	Optional	Default: 1 Format: int32 Maximum: 10000 Minimum: 1
`query.perPage`	integer	Optional	Default: 200 Format: int32 Maximum: 200 Minimum: 1
`query.sort_by`	string	Optional	One of: id, Created_Time, Modified_Time Maximum length: 50
`query.sort_order`	string	Optional	One of: asc, desc Maximum length: 10

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 payload containing the list of note records and pagination metadata for the specified parent record. Additional keys: not allowed
`$ (anyOf 1).data`	array	Required within parent	Represents the list of note records returned for the specified parent record. Maximum items: 200
`$ (anyOf 1).data[]`	object	Each item	Represents an individual note record associated with the parent record. Additional keys: allowed
`$ (anyOf 1).data[].$attachments`	JSON	Optional
`$ (anyOf 1).data[].$attachments (anyOf 1)`	array	Alternative	Represents the list of file attachments associated with the note. Maximum items: 5
`$ (anyOf 1).data[].$attachments (anyOf 1)[]`	Model	Each item	Expand Related Notes — related Notes get Notes — response body — data, info data item $attachments null item
`$ (anyOf 1).data[].$attachments (anyOf 2)`	null	Alternative	Represents the list of file attachments associated with the note. Maximum items: 5
`$ (anyOf 1).data[].$attachments (anyOf 2)[]`	Model	Each item	Expand Related Notes — related Notes get Notes — response body — data, info data item $attachments null item
`$ (anyOf 1).data[].Note_Content`	JSON	Optional
`$ (anyOf 1).data[].Note_Content (anyOf 1)`	string	Alternative	The content of the note. Maximum length: 65535
`$ (anyOf 1).data[].Note_Content (anyOf 2)`	null	Alternative	The content of the note. Maximum length: 65535
`$ (anyOf 1).data[].Note_Title`	JSON	Optional
`$ (anyOf 1).data[].Note_Title (anyOf 1)`	string	Alternative	Represents the title of the note. Maximum length: 255
`$ (anyOf 1).data[].Note_Title (anyOf 2)`	null	Alternative	Represents the title of the note. Maximum length: 255
`$ (anyOf 1).data[].Parent_Id`	object	Optional	Represents the parent record associated with the note. Additional keys: not allowed
`$ (anyOf 1).data[].Parent_Id.id`	string	Required within parent	Specify the unique ID of the parent record. Refer to Refer the [GET Records API](record.yaml#.$path./{module}.get) to get valid record IDs. Format: int64
`$ (anyOf 1).data[].Parent_Id.module`	object	Required within parent	Represents the module of the parent record. Additional keys: not allowed
`$ (anyOf 1).data[].Parent_Id.module.api_name`	string	Required within parent	Represents the API name of the parent record module. Refer to [Get Modules](modules.yaml#$.paths./settings/modules.get) for the list of supported modules. Maximum length: 50
`$ (anyOf 1).data[].Parent_Id.module.id`	string	Required within parent	Represents the unique identifier of the parent record module. Format: int64
`$ (anyOf 1).data[].Parent_Id.name`	string	Required within parent	Represents the name of the parent record. Maximum length: 255
`$ (anyOf 1).data[].id`	string	Required within parent	Represents the unique identifier of the note. Format: int64
`$ (anyOf 1).info`	object	Required within parent	Represents the pagination metadata for this response. Additional keys: not allowed
`$ (anyOf 1).info.count`	JSON	Required within parent
`$ (anyOf 1).info.count (anyOf 1)`	integer	Alternative	The number of note records returned in the current page. Format: int32
`$ (anyOf 1).info.count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.more_records`	boolean	Required within parent	Represents whether more note records are available beyond the current page.
`$ (anyOf 1).info.next_page_token`	JSON	Optional
`$ (anyOf 1).info.next_page_token (anyOf 1)`	string	Alternative	Indicates the token used to retrieve the next page of results. Maximum length: 1024
`$ (anyOf 1).info.next_page_token (anyOf 2)`	null	Alternative	Indicates the token used to retrieve the next page of results. Maximum length: 1024
`$ (anyOf 1).info.page`	JSON	Required within parent
`$ (anyOf 1).info.page (anyOf 1)`	integer	Alternative	Specifies the current page number. Format: int32
`$ (anyOf 1).info.page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.page_token_expiry`	JSON	Optional
`$ (anyOf 1).info.page_token_expiry (anyOf 1)`	string	Alternative	Represents the expiry date and time of the page tokens. Format: date-time
`$ (anyOf 1).info.page_token_expiry (anyOf 2)`	null	Alternative	Represents the expiry date and time of the page tokens. Format: date-time
`$ (anyOf 1).info.per_page`	JSON	Required within parent
`$ (anyOf 1).info.per_page (anyOf 1)`	integer	Alternative	Represents the number of records returned per page. Format: int32
`$ (anyOf 1).info.per_page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.previous_page_token`	JSON	Optional
`$ (anyOf 1).info.previous_page_token (anyOf 1)`	string	Alternative	Represents the token used to retrieve the previous page of results. Maximum length: 500
`$ (anyOf 1).info.previous_page_token (anyOf 2)`	null	Alternative	Represents the token used to retrieve the previous page of results. Maximum length: 500
`$ (anyOf 2)`	null	Alternative

Referenced models: Related Notes — related Notes get Notes — response body — data, info data item $attachments null item

Schemas

Related Notes — related Notes get Notes — response body — data, info data item $attachments null item

Field	Type	Presence	Description and constraints
`$`	object	Root	Specifies an individual file attachment associated with the note. Additional keys: allowed
`$file_id`	string	Optional	Specifies the unique file identifier of the attachment. Maximum length: 255
`File_Name`	string	Optional	Specifies the name of the attached file. Maximum length: 255
`Size`	string	Optional	Represents the size of the attached file in bytes. Format: int64
`id`	string	Optional	Indicates the unique identifier of the attachment record. Format: int64

Policy, approvals and errors

SDK function policy ID: zoho.getnotes. Catalog operation: getNotes. 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

Report an issue with this page