Zoho: Get a role

Zoho roles.getRole: arguments, response, policy and SDK examples.

Operation zoho.getrole

Provider route: GET /crm/v8/settings/roles/{role}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { ZohoIntegration } from "@alter-ai/zoho";

async function execute(input: Parameters<ZohoIntegration["roles"]["getRole"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.roles.getRole(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_zoho import ZohoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.roles.get_role(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`path`	object	Required within parent	Additional keys: not allowed
`path.role`	string	Required within parent	Maximum length: 19

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
`$`	JSON	Root
`$ (anyOf 1)`	object	Alternative	Represents the successful response containing the details of the specified CRM role. Additional keys: not allowed
`$ (anyOf 1).roles`	array	Required within parent	Represents the list containing the requested CRM role. Maximum items: 1
`$ (anyOf 1).roles[]`	object	Each item	Represents the requested role. Additional keys: not allowed
`$ (anyOf 1).roles[].api_name`	string	Optional	Represents the API name identifier for the role, used to reference the role programmatically. Maximum length: 100
`$ (anyOf 1).roles[].created_by__s`	JSON	Required within parent
`$ (anyOf 1).roles[].created_by__s (anyOf 1)`	object	Alternative	Represents the user who created this role. Additional keys: not allowed
`$ (anyOf 1).roles[].created_by__s (anyOf 1).id`	string	Required within parent	Represents the unique ID of the user who created the role. Maximum length: 19
`$ (anyOf 1).roles[].created_by__s (anyOf 1).name`	string	Required within parent	Represents the display name of the user who created the role. Maximum length: 255
`$ (anyOf 1).roles[].created_by__s (anyOf 2)`	null	Alternative	Represents the user who created this role. Additional keys: not allowed
`$ (anyOf 1).roles[].created_by__s (anyOf 2).id`	string	Required within parent	Represents the unique ID of the user who created the role. Maximum length: 19
`$ (anyOf 1).roles[].created_by__s (anyOf 2).name`	string	Required within parent	Represents the display name of the user who created the role. Maximum length: 255
`$ (anyOf 1).roles[].created_time__s`	JSON	Required within parent
`$ (anyOf 1).roles[].created_time__s (anyOf 1)`	string	Alternative	Represents the timestamp indicating when the role was added to the organization. Format: date-time
`$ (anyOf 1).roles[].created_time__s (anyOf 2)`	null	Alternative	Represents the timestamp indicating when the role was added to the organization. Format: date-time
`$ (anyOf 1).roles[].description`	JSON	Required within parent
`$ (anyOf 1).roles[].description (anyOf 1)`	string	Alternative	Represents the description of the role, providing additional context about its purpose and responsibilities. Maximum length: 255
`$ (anyOf 1).roles[].description (anyOf 2)`	null	Alternative	Represents the description of the role, providing additional context about its purpose and responsibilities. Maximum length: 255
`$ (anyOf 1).roles[].display_label`	string	Required within parent	Represents the display label of the role as shown in the Zoho CRM user interface. Maximum length: 200
`$ (anyOf 1).roles[].forecast_manager`	JSON	Required within parent
`$ (anyOf 1).roles[].forecast_manager (anyOf 1)`	object	Alternative	Represents the forecast manager assigned to this role. Additional keys: not allowed
`$ (anyOf 1).roles[].forecast_manager (anyOf 1).id`	string	Required within parent	Represents the unique ID of the forecast manager assigned to the role. Maximum length: 19
`$ (anyOf 1).roles[].forecast_manager (anyOf 1).name`	string	Required within parent	Represents the display name of the forecast manager assigned to the role. Maximum length: 255
`$ (anyOf 1).roles[].forecast_manager (anyOf 2)`	null	Alternative	Represents the forecast manager assigned to this role. Additional keys: not allowed
`$ (anyOf 1).roles[].forecast_manager (anyOf 2).id`	string	Required within parent	Represents the unique ID of the forecast manager assigned to the role. Maximum length: 19
`$ (anyOf 1).roles[].forecast_manager (anyOf 2).name`	string	Required within parent	Represents the display name of the forecast manager assigned to the role. Maximum length: 255
`$ (anyOf 1).roles[].id`	string	Required within parent	Represents the unique ID of the role. Maximum length: 19
`$ (anyOf 1).roles[].modified_by__s`	JSON	Required within parent
`$ (anyOf 1).roles[].modified_by__s (anyOf 1)`	object	Alternative	Represents the user who last modified this role. Additional keys: not allowed
`$ (anyOf 1).roles[].modified_by__s (anyOf 1).id`	string	Required within parent	Represents the unique ID of the user who last modified the role. Maximum length: 19
`$ (anyOf 1).roles[].modified_by__s (anyOf 1).name`	string	Required within parent	Represents the display name of the user who last modified the role. Maximum length: 255
`$ (anyOf 1).roles[].modified_by__s (anyOf 2)`	null	Alternative	Represents the user who last modified this role. Additional keys: not allowed
`$ (anyOf 1).roles[].modified_by__s (anyOf 2).id`	string	Required within parent	Represents the unique ID of the user who last modified the role. Maximum length: 19
`$ (anyOf 1).roles[].modified_by__s (anyOf 2).name`	string	Required within parent	Represents the display name of the user who last modified the role. Maximum length: 255
`$ (anyOf 1).roles[].modified_time__s`	JSON	Required within parent
`$ (anyOf 1).roles[].modified_time__s (anyOf 1)`	string	Alternative	Represents the timestamp at which the role was last modified. Format: date-time
`$ (anyOf 1).roles[].modified_time__s (anyOf 2)`	null	Alternative	Represents the timestamp at which the role was last modified. Format: date-time
`$ (anyOf 1).roles[].name`	string	Required within parent	Represents the display name of the role. Maximum length: 200
`$ (anyOf 1).roles[].reporting_to`	JSON	Required within parent
`$ (anyOf 1).roles[].reporting_to (anyOf 1)`	Model	Alternative	Expand Get all roles — response body — roles item reporting to id, name — shared_reporting-to_af4a3e36af00
`$ (anyOf 1).roles[].reporting_to (anyOf 2)`	Model	Alternative	Expand Get all roles — response body — roles item reporting to id, name — shared_reporting-to_74eeb41eb516
`$ (anyOf 1).roles[].share_with_peers`	boolean	Required within parent	Indicates whether users assigned to this role can share records with users in peer roles at the same level. Possible values: true - Users assigned to this role can share records with peer role users. false - Users assigned to this role cannot share records with peer role users.
`$ (anyOf 2)`	null	Alternative

Referenced models: Get all roles — response body — roles item reporting to id, name — shared_reporting-to_74eeb41eb516, Get all roles — response body — roles item reporting to id, name — shared_reporting-to_af4a3e36af00

Schemas

Get all roles — response body — roles item reporting to id, name — shared_reporting-to_74eeb41eb516

Field	Type	Presence	Description and constraints
`$`	null	Root	Represents the parent role to which this role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique ID of the parent role in the role hierarchy. Maximum length: 19
`name`	string	Required within parent	Represents the display name of the parent role in the role hierarchy. Maximum length: 255

Get all roles — response body — roles item reporting to id, name — shared_reporting-to_af4a3e36af00

Field	Type	Presence	Description and constraints
`$`	object	Root	Represents the parent role to which this role reports in the CRM role hierarchy. Refer to the [Get Roles](roles.yaml#$.paths./settings/roles.get) resource for valid values. Additional keys: not allowed
`id`	string	Required within parent	Represents the unique ID of the parent role in the role hierarchy. Maximum length: 19
`name`	string	Required within parent	Represents the display name of the parent role in the role hierarchy. Maximum length: 255

Policy, approvals and errors

SDK function policy ID: zoho.getrole. Catalog operation: getRole. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

No-content response statuses: [204]

Official provider source

Report an issue with this page