> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho CRM: Share Records Get Share Records

> List the users a Zoho CRM record is shared with, and their access level. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

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

> [!NOTE]
>
> 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
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`. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get Share Records. API exposed to customers",
    "properties": {
      "moduleApiName": {
        "type": "string",
        "description": "API name of the module",
        "maxLength": 100
      },
      "recordId": {
        "type": "string",
        "description": "ID of the record",
        "maxLength": 20
      },
      "sharedTo": {
        "type": "string",
        "description": "To specify to whom the record is shared",
        "maxLength": 20
      },
      "view": {
        "type": "string",
        "description": "To get the summary of share records",
        "enum": [
          "manage",
          "summary"
        ]
      }
    },
    "required": [
      "moduleApiName",
      "recordId"
    ],
    "additionalProperties": false
  }
  ```
</details>

## 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). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Get Share Records Success Response",
        "properties": {
          "share": {
            "type": "array",
            "description": "list of share records",
            "maxItems": 2147483647,
            "items": {
              "type": "object",
              "description": "share record details",
              "properties": {
                "shared_with": {
                  "type": "object",
                  "description": "details of whom the record is shared with",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "name of the entity with whom the record is shared",
                      "maxLength": 100
                    },
                    "id": {
                      "type": "string",
                      "description": "id of the entity with whom the record is shared",
                      "maxLength": 20
                    },
                    "type": {
                      "type": "string",
                      "description": "type of entity with whom the record is shared",
                      "enum": [
                        "users",
                        "roles",
                        "groups"
                      ]
                    }
                  },
                  "required": [
                    "name",
                    "id",
                    "type"
                  ],
                  "additionalProperties": false
                },
                "share_related_records": {
                  "type": "boolean",
                  "description": "indicates if related records are shared"
                },
                "shared_through": {
                  "type": "object",
                  "description": "details of the record through which sharing is done",
                  "properties": {
                    "module": {
                      "type": "object",
                      "description": "module details",
                      "properties": {
                        "name": {
                          "type": "string",
                          "description": "module name",
                          "maxLength": 100
                        },
                        "id": {
                          "type": "string",
                          "description": "module id",
                          "maxLength": 20
                        }
                      },
                      "required": [
                        "name",
                        "id"
                      ],
                      "additionalProperties": false
                    },
                    "id": {
                      "type": "string",
                      "description": "id of the record through which sharing is done",
                      "maxLength": 20
                    }
                  },
                  "required": [
                    "module",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "shared_time": {
                  "type": "string",
                  "description": "time when the record was shared",
                  "format": "date-time"
                },
                "permission": {
                  "type": "string",
                  "description": "level of access granted",
                  "enum": [
                    "read_only",
                    "read_write",
                    "full_access"
                  ]
                },
                "shared_by": {
                  "type": "object",
                  "description": "details of the user who shared the record",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "name of the user who shared the record",
                      "maxLength": 100
                    },
                    "id": {
                      "type": "string",
                      "description": "id of the user who shared the record",
                      "maxLength": 20
                    },
                    "zuid": {
                      "type": "string",
                      "description": "zuid of the user who shared the record",
                      "maxLength": 20
                    }
                  },
                  "required": [
                    "name",
                    "id",
                    "zuid"
                  ],
                  "additionalProperties": false
                },
                "type": {
                  "type": "string",
                  "description": "type of sharing",
                  "enum": [
                    "private",
                    "public"
                  ]
                }
              },
              "required": [
                "shared_with",
                "share_related_records",
                "shared_through",
                "permission",
                "type"
              ],
              "additionalProperties": false
            }
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.