> ## 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: README

> Get Email Shared Details. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Get Email Shared Details.

<Info>
  Tool ID: `zoho_crm_emails_sharing_details_get_email_sharing_detail`
</Info>

## Run this action

Use the TypeScript SDK for a single call. Put `ctx.tools.execute(...)` inside a Play when the call should be durable, scheduled, or run across a CSV.

```ts theme={null}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'zoho_crm_emails_sharing_details_get_email_sharing_detail',
  {
    "moduleApiName": "Leads",
    "id": "id_123"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_emails_sharing_details_get_email_sharing_detail --input '{
  "moduleApiName": "Leads",
  "id": "id_123"
}' --json
```

## Example response

The static output schema is not detailed enough to generate a reliable example. Use `deepline tools get zoho_crm_emails_sharing_details_get_email_sharing_detail --json` for the complete live contract.

## Input reference

To get the details of the users and the type with whom you can share the record's emails.

| Name                    | Type                                                                | Required | Default | Details                                                                                           |
| ----------------------- | ------------------------------------------------------------------- | -------- | ------- | ------------------------------------------------------------------------------------------------- |
| `payload.moduleApiName` | `"Leads" \| "Contacts" \| "Accounts" \| "Deals" \| "CustomModule1"` | Yes      | —       | Module Api Name of the record Allowed: `Leads`, `Contacts`, `Accounts`, `Deals`, `CustomModule1`. |
| `payload.id`            | `string`                                                            | Yes      | —       | ID of the record whose email sharing details are to be fetched Maximum length: 100.               |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "To get the details of the users and the type with whom you can share the record's emails.",
    "properties": {
      "moduleApiName": {
        "type": "string",
        "description": "Module Api Name of the record",
        "enum": [
          "Leads",
          "Contacts",
          "Accounts",
          "Deals",
          "CustomModule1"
        ]
      },
      "id": {
        "type": "string",
        "description": "ID of the record whose email sharing details are to be fetched",
        "maxLength": 100
      }
    },
    "required": [
      "moduleApiName",
      "id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                                               | Type                       | Required | Default | Details                                                                    |
| ------------------------------------------------------------------ | -------------------------- | -------- | ------- | -------------------------------------------------------------------------- |
| `result.data`                                                      | `object`                   | Yes      | —       | Response Object for Get Email Shared Details                               |
| `result.data.__emails_sharing_details`                             | `array`                    | No       | —       | List of email sharing details Maximum items: 1.                            |
| `result.data.__emails_sharing_details[].shared_from_users`         | `array`                    | Yes      | —       | List of users with whom the email can be shared Maximum items: 50.         |
| `result.data.__emails_sharing_details[].shared_from_users[].name`  | `string`                   | Yes      | —       | Name of the user Maximum length: 250.                                      |
| `result.data.__emails_sharing_details[].shared_from_users[]._type` | `"imap" \| "pop" \| "api"` | Yes      | —       | Type of email account Allowed: `imap`, `pop`, `api`.                       |
| `result.data.__emails_sharing_details[].shared_from_users[].id`    | `string`                   | Yes      | —       | User ID of the user Maximum length: 100.                                   |
| `result.data.__emails_sharing_details[].available_types`           | `array`                    | Yes      | —       | List of available email filter options Minimum items: 1. Maximum items: 5. |
| `result.meta`                                                      | `object`                   | No       | —       | Additional response metadata (status, paging).                             |

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

  ### Output JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response Object for Get Email Shared Details",
        "properties": {
          "__emails_sharing_details": {
            "type": "array",
            "description": "List of email sharing details",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Details of email sharing options",
              "properties": {
                "shared_from_users": {
                  "type": "array",
                  "description": "List of users with whom the email can be shared",
                  "maxItems": 50,
                  "items": {
                    "type": "object",
                    "description": "Details of the user with whom the email can be shared",
                    "properties": {
                      "name": {
                        "type": "string",
                        "description": "Name of the user",
                        "maxLength": 250
                      },
                      "_type": {
                        "type": "string",
                        "description": "Type of email account",
                        "enum": [
                          "imap",
                          "pop",
                          "api"
                        ]
                      },
                      "id": {
                        "type": "string",
                        "description": "User ID of the user",
                        "maxLength": 100
                      }
                    },
                    "required": [
                      "name",
                      "_type",
                      "id"
                    ],
                    "additionalProperties": false
                  }
                },
                "available_types": {
                  "type": "array",
                  "description": "List of available email filter options",
                  "minItems": 1,
                  "maxItems": 5,
                  "items": {
                    "type": "string",
                    "description": "Type of email filter options available",
                    "enum": [
                      "emails_sent_from_crm",
                      "all_contacts_emails",
                      "all_imap_shared_users",
                      "all_pop_shared_users",
                      "all_emails"
                    ]
                  }
                }
              },
              "required": [
                "shared_from_users",
                "available_types"
              ],
              "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](/docs/sdk-v2/quickstart)
* [SDK reference](/docs/sdk-v2/sdk-reference)
* [Run tools across a CSV](/docs/sdk-v2/batch-csv)