> ## 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 specific role. Zoho CRM Roles Get Role reference includes SDK V2 and CLI requests, input constraints, response fields, and Deepline cost.

Get specific role.

<Info>
  Tool ID: `zoho_crm_roles_get_role`
</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_roles_get_role',
  {
    "role": "example"
  },
);

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

### CLI

```bash theme={null}
deepline tools execute zoho_crm_roles_get_role --input '{
  "role": "example"
}' --json
```

## Example response

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

## Input reference

Retrieve details of a specific CRM role by its identifier

| Name           | Type     | Required | Default | Details                             |
| -------------- | -------- | -------- | ------- | ----------------------------------- |
| `payload.role` | `string` | Yes      | —       | Role identifier Maximum length: 19. |

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

  ### Input JSON Schema

  ```json theme={null}
  {
    "type": "object",
    "description": "Retrieve details of a specific CRM role by its identifier",
    "properties": {
      "role": {
        "type": "string",
        "description": "Role identifier",
        "maxLength": 19
      }
    },
    "required": [
      "role"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name                                        | Type             | Required | Default | Details                                                                        |
| ------------------------------------------- | ---------------- | -------- | ------- | ------------------------------------------------------------------------------ |
| `result.data`                               | `object`         | Yes      | —       | Response containing single role details                                        |
| `result.data.roles`                         | `array`          | Yes      | —       | Array containing the requested role Maximum items: 1.                          |
| `result.data.roles[].display_label`         | `string`         | Yes      | —       | Display label for the role Maximum length: 200.                                |
| `result.data.roles[].forecast_manager`      | `object \| null` | Yes      | —       | Information about the forecast manager for this role                           |
| `result.data.roles[].forecast_manager.id`   | `string`         | Yes      | —       | Unique identifier of the forecast manager Maximum length: 19.                  |
| `result.data.roles[].forecast_manager.name` | `string`         | Yes      | —       | Display name of the forecast manager Maximum length: 255.                      |
| `result.data.roles[].reporting_to`          | `object \| null` | Yes      | —       | Information about the role this role reports to                                |
| `result.data.roles[].reporting_to.id`       | `string`         | Yes      | —       | Unique identifier of the parent role Maximum length: 19.                       |
| `result.data.roles[].reporting_to.name`     | `string`         | Yes      | —       | Display name of the parent role Maximum length: 255.                           |
| `result.data.roles[].api_name`              | `string`         | No       | —       | API name identifier for the role Maximum length: 100.                          |
| `result.data.roles[].share_with_peers`      | `boolean`        | Yes      | —       | Whether this role can share data with peer roles                               |
| `result.data.roles[].description`           | `string \| null` | Yes      | —       | Detailed description of the role and its responsibilities Maximum length: 255. |
| `result.data.roles[].id`                    | `string`         | Yes      | —       | Unique identifier for the role Maximum length: 19.                             |
| `result.data.roles[].name`                  | `string`         | Yes      | —       | Display name of the role Maximum length: 200.                                  |
| `result.data.roles[].created_by__s`         | `object \| null` | Yes      | —       | Information about the user who created this role                               |
| `result.data.roles[].created_by__s.name`    | `string`         | Yes      | —       | Display name of the user who created the role Maximum length: 255.             |
| `result.data.roles[].created_by__s.id`      | `string`         | Yes      | —       | Unique identifier of the user who created the role Maximum length: 19.         |
| `result.data.roles[].modified_by__s`        | `object \| null` | Yes      | —       | Information about the user who last modified this role                         |
| `result.data.roles[].modified_by__s.name`   | `string`         | Yes      | —       | Display name of the user who last modified the role Maximum length: 255.       |
| `result.data.roles[].modified_by__s.id`     | `string`         | Yes      | —       | Unique identifier of the user who last modified the role Maximum length: 19.   |
| `result.data.roles[].modified_time__s`      | `string \| null` | Yes      | —       | Timestamp when the role was last modified Format: `date-time`.                 |
| `result.data.roles[].created_time__s`       | `string \| null` | Yes      | —       | Timestamp when the role was created Format: `date-time`.                       |
| `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 containing single role details",
        "properties": {
          "roles": {
            "type": "array",
            "description": "Array containing the requested role",
            "maxItems": 1,
            "items": {
              "type": "object",
              "description": "Individual role object",
              "properties": {
                "display_label": {
                  "type": "string",
                  "description": "Display label for the role",
                  "maxLength": 200
                },
                "forecast_manager": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Information about the forecast manager for this role",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the forecast manager",
                      "maxLength": 19
                    },
                    "name": {
                      "type": "string",
                      "description": "Display name of the forecast manager",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "reporting_to": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Information about the role this role reports to",
                  "properties": {
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the parent role",
                      "maxLength": 19
                    },
                    "name": {
                      "type": "string",
                      "description": "Display name of the parent role",
                      "maxLength": 255
                    }
                  },
                  "required": [
                    "id",
                    "name"
                  ],
                  "additionalProperties": false
                },
                "api_name": {
                  "type": "string",
                  "description": "API name identifier for the role",
                  "maxLength": 100
                },
                "share_with_peers": {
                  "type": "boolean",
                  "description": "Whether this role can share data with peer roles"
                },
                "description": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Detailed description of the role and its responsibilities",
                  "maxLength": 255
                },
                "id": {
                  "type": "string",
                  "description": "Unique identifier for the role",
                  "maxLength": 19
                },
                "name": {
                  "type": "string",
                  "description": "Display name of the role",
                  "maxLength": 200
                },
                "created_by__s": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Information about the user who created this role",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the user who created the role",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the user who created the role",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "modified_by__s": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Information about the user who last modified this role",
                  "properties": {
                    "name": {
                      "type": "string",
                      "description": "Display name of the user who last modified the role",
                      "maxLength": 255
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier of the user who last modified the role",
                      "maxLength": 19
                    }
                  },
                  "required": [
                    "name",
                    "id"
                  ],
                  "additionalProperties": false
                },
                "modified_time__s": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Timestamp when the role was last modified",
                  "format": "date-time"
                },
                "created_time__s": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "Timestamp when the role was created",
                  "format": "date-time"
                }
              },
              "required": [
                "display_label",
                "forecast_manager",
                "reporting_to",
                "share_with_peers",
                "description",
                "id",
                "name",
                "created_by__s",
                "modified_by__s",
                "modified_time__s",
                "created_time__s"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "roles"
        ],
        "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)