> ## 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: Data Sharing Get Data Sharing

> Get your Zoho CRM data sharing rules, showing each module's default access level. Includes inputs, outputs, SDK V2 examples, and Deepline cost.

Get your Zoho CRM data sharing rules, showing each module's default access level.

> [!NOTE]
>
> Tool ID: `zoho_crm_data_sharing_get_data_sharing`

## 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_data_sharing_get_data_sharing',
  {},
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute zoho_crm_data_sharing_get_data_sharing --input '{}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "data_sharing": [
      {
        "share_type": "private",
        "public_in_portals": true,
        "module": {
          "api_name": "Example",
          "id": "id_123"
        },
        "rule_computation_running": true
      }
    ]
  }
}
```

Use `deepline describe zoho_crm_data_sharing_get_data_sharing --json` for the latest machine-readable contract.

## Input reference

Get the data sharing settings configured.API exposed to customers

This action requires no input fields.

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

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Get the data sharing settings configured.API exposed to customers",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Data Sharing Get Response |
| `result.data.data_sharing` | `array` | Yes | — | List of Data Sharing Settings Maximum items: 50. |
| `result.data.data_sharing[].share_type` | `"private" \| "public_read_write" \| "public" \| "public_read_only"` | Yes | — | Stores the module-level data sharing permission type Allowed: `private`, `public_read_write`, `public`, `public_read_only`. |
| `result.data.data_sharing[].public_in_portals` | `boolean` | Yes | — | Indicates whether the module is made as public in portals |
| `result.data.data_sharing[].module` | `object` | Yes | — | Module Information |
| `result.data.data_sharing[].module.api_name` | `string` | Yes | — | API Name of the Module Maximum length: 100. |
| `result.data.data_sharing[].module.id` | `string` | Yes | — | ID of the Module Maximum length: 20. |
| `result.data.data_sharing[].rule_computation_running` | `boolean` | Yes | — | Indicates whether the sharing rules computation is currently running for the module |
| `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": "Data Sharing Get Response",
        "properties": {
          "data_sharing": {
            "type": "array",
            "description": "List of Data Sharing Settings",
            "maxItems": 50,
            "items": {
              "type": "object",
              "description": "Data Sharing Setting",
              "properties": {
                "share_type": {
                  "type": "string",
                  "description": "Stores the module-level data sharing permission type",
                  "enum": [
                    "private",
                    "public_read_write",
                    "public",
                    "public_read_only"
                  ]
                },
                "public_in_portals": {
                  "type": "boolean",
                  "description": "Indicates whether the module is made as public in portals"
                },
                "module": {
                  "type": "object",
                  "description": "Module Information",
                  "properties": {
                    "api_name": {
                      "type": "string",
                      "description": "API Name of the Module",
                      "maxLength": 100
                    },
                    "id": {
                      "type": "string",
                      "description": "ID of the Module",
                      "maxLength": 20
                    }
                  },
                  "required": [
                    "api_name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "rule_computation_running": {
                  "type": "boolean",
                  "description": "Indicates whether the sharing rules computation is currently running for the module"
                }
              },
              "required": [
                "share_type",
                "public_in_portals",
                "module",
                "rule_computation_running"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "data_sharing"
        ],
        "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.