Zoho CRM: Share Records Get Share Records

List the users a Zoho CRM record is shared with, and their access level.

Tool ID: zoho_crm_share_records_get_share_records

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.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_share_records_get_share_records',
  {
    "moduleApiName": "Example",
    "recordId": "record_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute zoho_crm_share_records_get_share_records --input '{
  "moduleApiName": "Example",
  "recordId": "record_123"
}' --json

Example response

The static output schema lacks the details for a reliable example. Use deepline describe zoho_crm_share_records_get_share_records --json for the complete live contract.

Input reference

Get Share Records. API exposed to customers

Name	Type	Required	Default	Details
`payload.moduleApiName`	`string`	Yes	—	API name of the module Maximum length: 100.
`payload.recordId`	`string`	Yes	—	ID of the record Maximum length: 20.
`payload.sharedTo`	`string`	No	—	To specify to whom the record is shared Maximum length: 20.
`payload.view`	`"manage" \| "summary"`	No	—	To get the summary of share records Allowed: `manage`, `summary`.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Get Share Records Success Response
`result.data.share`	`array`	No	—	list of share records Maximum items: 2147483647.
`result.data.share[].shared_with`	`object`	Yes	—	details of whom the record is shared with
`result.data.share[].shared_with.name`	`string`	Yes	—	name of the entity with whom the record is shared Maximum length: 100.
`result.data.share[].shared_with.id`	`string`	Yes	—	id of the entity with whom the record is shared Maximum length: 20.
`result.data.share[].shared_with.type`	`"users" \| "roles" \| "groups"`	Yes	—	type of entity with whom the record is shared Allowed: `users`, `roles`, `groups`.
`result.data.share[].share_related_records`	`boolean`	Yes	—	indicates if related records are shared
`result.data.share[].shared_through`	`object`	Yes	—	details of the record through which sharing is done
`result.data.share[].shared_through.module`	`object`	Yes	—	module details
`result.data.share[].shared_through.module.name`	`string`	Yes	—	module name Maximum length: 100.
`result.data.share[].shared_through.module.id`	`string`	Yes	—	module id Maximum length: 20.
`result.data.share[].shared_through.id`	`string`	Yes	—	id of the record through which sharing is done Maximum length: 20.
`result.data.share[].shared_time`	`string`	No	—	time when the record was shared Format: `date-time`.
`result.data.share[].permission`	`"read_only" \| "read_write" \| "full_access"`	Yes	—	level of access granted Allowed: `read_only`, `read_write`, `full_access`.
`result.data.share[].shared_by`	`object`	No	—	details of the user who shared the record
`result.data.share[].shared_by.name`	`string`	Yes	—	name of the user who shared the record Maximum length: 100.
`result.data.share[].shared_by.id`	`string`	Yes	—	id of the user who shared the record Maximum length: 20.
`result.data.share[].shared_by.zuid`	`string`	Yes	—	zuid of the user who shared the record Maximum length: 20.
`result.data.share[].type`	`"private" \| "public"`	Yes	—	type of sharing Allowed: `private`, `public`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation