Zoho: Get a record by ID from a specified module

← Record operations · Get started

Operation zoho.getrecord

Provider route: GET /crm/v8/{module}/{recordId}. 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["record"]["getRecord"]>[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.record.getRecord(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.record.get_record(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.recordId	string	Required within parent	Format: int64
path.module	string	Required within parent	Maximum length: 25

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)	Model	Alternative	Expand Get a record by ID from a specified module — response body — data
$ (anyOf 2)	null	Alternative

Referenced models: Get a record by ID from a specified module — response body — data

Schemas

Get a record by ID from a specified module — response body — data

Field	Type	Presence	Description and constraints
$	object	Root	Represents the response schema for the record ID GET success operation. Additional keys: not allowed
data	array	Required within parent	Represents the data value. Maximum items: 1 Minimum items: 1
data[]	Model	Each item	Expand Get a record by ID from a specified module — response body — data data item

Referenced models: Get a record by ID from a specified module — response body — data data item

Get a record by ID from a specified module — response body — data data item

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single record GET data result item. Additional keys: allowed
$state	string	Optional	This will be as Save or Draft. 'save' indicates the record is not in any active Blueprint Maximum length: 255
$wizard_connection_path	JSON	Optional
$wizard_connection_path (anyOf 1)	string	Alternative	$wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false
$wizard_connection_path (anyOf 2)	null	Alternative	$wizard_connection_path information denoted by comma separated connection ids between wizard screens. Maximum length: 2000 Read only: false
Created_By	Model	Optional	Expand Get a record by ID from a specified module — response body — data data item Created By
Created_Time	string	Optional	Represents the timestamp when the record was originally created. Format: date-time
Modified_By	Model	Optional	Expand Get a record by ID from a specified module — response body — data data item Modified By
Modified_Time	string	Optional	Represents the timestamp when the record was last modified. Format: date-time
Owner	object	Optional	Represents the owner value. Additional keys: not allowed
Owner.email	string	Optional	Represents the owner value. Maximum length: 256
Owner.id	string	Required within parent	Represents the owner value. Format: int64
Owner.name	string	Required within parent	Represents the owner value. Maximum length: 101
Wizard	object	Optional	Represents the wizard value. Additional keys: not allowed
Wizard.id	string	Required within parent	Represents the wizard value. Format: int64 Maximum length: 19
id	string	Optional	Represents the unique identifier of the RecordGETDataItem record. Format: int64

Referenced models: Get a record by ID from a specified module — response body — data data item Created By, Get a record by ID from a specified module — response body — data data item Modified By

Get a record by ID from a specified module — response body — data data item Created By

Field	Type	Presence	Description and constraints
$	object	Root	Contains information about the user who originally created the record. Additional keys: not allowed
email	string	Optional	Contains information about the user who originally created the record. Maximum length: 255
id	string	Required within parent	Contains information about the user who originally created the record. Format: int64
name	string	Required within parent	Contains information about the user who originally created the record. Maximum length: 101

Get a record by ID from a specified module — response body — data data item Modified By

Field	Type	Presence	Description and constraints
$	object	Root	Contains information about the user who last modified the record. Additional keys: not allowed
email	string	Optional	Contains information about the user who last modified the record. Maximum length: 255
id	string	Required within parent	Contains information about the user who last modified the record. Format: int64
name	string	Required within parent	Contains information about the user who last modified the record. Maximum length: 101

Policy, approvals and errors

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