Zoho: Get a Contact Role

← Contact roles operations · Get started

Operation zoho.getcontactrole

Provider route: GET /crm/v8/Contacts/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["contactRoles"]["getContactRole"]>[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.contactRoles.getContactRole(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.contact_roles.get_contact_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: 255

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	Contains the details of the specified contact role. Additional keys: not allowed
$ (anyOf 1).contact_roles	array	Required within parent	Represents the details of the specified contact role. Maximum items: 100
$ (anyOf 1).contact_roles[]	object	Each item	Represents a contact role entry, including its name, unique ID, and display position. Additional keys: not allowed
$ (anyOf 1).contact_roles[].id	string	Required within parent	Represents the unique ID of the contact role. Maximum length: 19
$ (anyOf 1).contact_roles[].name	string	Required within parent	Represents the name of the contact role. Maximum length: 50 Pattern: [A-Za-z0-9 ]
$ (anyOf 1).contact_roles[].sequence_number	JSON	Required within parent
$ (anyOf 1).contact_roles[].sequence_number (anyOf 1)	number	Alternative	Represents the display position of the contact role in the CRM UI picklist.
$ (anyOf 1).contact_roles[].sequence_number (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
$ (anyOf 2)	null	Alternative

Policy, approvals and errors

SDK function policy ID: zoho.getcontactrole. Catalog operation: getContactRole. 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