Zoho: Share Records

← Share records operations · Get started

Operation zoho.getsharerecords

Provider route: GET /crm/v8/{moduleApiName}/{recordId}/actions/share. 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["shareRecords"]["getShareRecords"]>[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.shareRecords.getShareRecords(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.share_records.get_share_records(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.moduleApiName	string	Required within parent	Unique API identifier for the module used in third-party integrations; starts with a letter, contains only alphanumeric characters and underscores, and has no consecutive or trailing underscores. Maximum length: 50
path.recordId	string	Required within parent	Represents the unique identifier of the RecordGETDataItem record. Format: int64
query	object	Optional	Additional keys: not allowed
query.sharedTo	string	Optional	Represents the unique identifier of the user. Maximum length: 19
query.view	string	Optional	One of: manage, summary
query.approved	string	Optional	One of: true, false, both
query.current_user	boolean	Optional

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	Represents the success response. Additional keys: not allowed
$ (anyOf 1).share	array	Optional	Represents the list of share records. Maximum items: 2147483647
$ (anyOf 1).share[]	object	Each item	Each object represents a single share entry, including the recipient, the access level, and the sharing metadata. Additional keys: not allowed
$ (anyOf 1).share[].permission	string	Required within parent	Represents the level of access granted to the entity for the shared record. Possible values: - read_only - read_write - full_access Known values: read_only, read_write, full_access
$ (anyOf 1).share[].share_related_records	boolean	Required within parent	Indicates whether the related records of the shared record are also shared with the entity.
$ (anyOf 1).share[].shared_by	object	Optional	Represents the details of the user who shared the record. Additional keys: not allowed
$ (anyOf 1).share[].shared_by.id	string	Required within parent	Represents the unique ID of the entity. Maximum length: 19
$ (anyOf 1).share[].shared_by.name	string	Required within parent	Represents the name of the entity. Maximum length: 100
$ (anyOf 1).share[].shared_by.zuid	string	Required within parent	Represents the ZUID of the user who shared the record. Maximum length: 19
$ (anyOf 1).share[].shared_through	object	Required within parent	Represents the details of the record through which sharing is granted, including its module. Additional keys: not allowed
$ (anyOf 1).share[].shared_through.id	string	Required within parent	Represents the unique ID of the record through which sharing is enabled. Maximum length: 19
$ (anyOf 1).share[].shared_through.module	object	Required within parent	Represents the module details of the record through which sharing is granted. Additional keys: not allowed
$ (anyOf 1).share[].shared_through.module.id	string	Required within parent	Represents the unique ID of the module. Maximum length: 19
$ (anyOf 1).share[].shared_through.module.name	string	Required within parent	Represents the name of the module. Maximum length: 100
$ (anyOf 1).share[].shared_time	string	Optional	Represents the date and time at which the record was shared, in ISO 8601 format. Format: date-time
$ (anyOf 1).share[].shared_with	object	Required within parent	Represents the details of the entity (user, role, or group) with which the record is shared. Additional keys: not allowed
$ (anyOf 1).share[].shared_with.id	string	Required within parent	Represents the unique ID of the entity with whom the record is shared. Maximum length: 19
$ (anyOf 1).share[].shared_with.name	string	Required within parent	Represents the name of the entity with whom the record is shared. Maximum length: 100
$ (anyOf 1).share[].shared_with.type	string	Required within parent	Represents the type of sharing applied to the record. Possible values: - users - roles - groups Known values: users, roles, groups
$ (anyOf 1).share[].type	string	Required within parent	Represents the type of sharing applied to the record. Possible values: - private - public Known values: private, public
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

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