> ## 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: Roles Get Roles

> List the roles in your Zoho CRM role hierarchy. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

List the roles in your Zoho CRM role hierarchy.

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

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

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

### CLI

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

## Example response

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

## Input reference

Retrieve a list of all CRM roles in the organization

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": "Retrieve a list of all CRM roles in the organization",
    "properties": {},
    "required": [],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Response containing list of CRM roles |
| `result.data.roles` | `array` | Yes | — | Array of role objects Maximum items: 250. |
| `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: 1000. |
| `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={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Response containing list of CRM roles",
        "properties": {
          "roles": {
            "type": "array",
            "description": "Array of role objects",
            "maxItems": 250,
            "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": 1000
                },
                "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](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.