Zoho CRM: Roles Get Roles

List the roles in your Zoho CRM role hierarchy.

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.

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

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.

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

Deepline cost

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

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation