Skip to content

Zoho: Deal Contact Roles — deal Contact Roles get Deal Contact Role For Contact

Zoho dealContactRoles.getDealContactRoleForContact: arguments, response, policy and SDK examples.

← Deal contact roles operations · Get started

Operation zoho.getdealcontactroleforcontact

Provider route: GET /crm/v8/{module}/{dealId}/Contact_Roles/{contactId}. Alter supplies the connection’s credentials and routing.

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["dealContactRoles"]["getDealContactRoleForContact"]>[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.dealContactRoles.getDealContactRoleForContact(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.deal_contact_roles.get_deal_contact_role_for_contact(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.modulestringRequired within parentOne of: Deals
path.dealIdstringRequired within parentFormat: int64
path.contactIdstringRequired within parentFormat: int64
queryobjectRequired within parentAdditional keys: not allowed
query.fieldsstringRequired within parentMaximum length: 1000
Minimum length: 1
Pattern: ^[A-Za-z_][A-Za-z0-9_](?:,[A-Za-z_][A-Za-z0-9_])*$

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeResponse body containing the contact role relation for the specified contact.
Additional keys: not allowed
$ (anyOf 1).dataarrayRequired within parentArray containing the contact role record for the specified contact
Maximum items: 1
Minimum items: 1
$ (anyOf 1).data[]ModelEach itemExpand Deal Contact Roles — deal Contact Roles get Deal Contact Role For Contact — response body — data data item
$ (anyOf 2)nullAlternative

Referenced models: Deal Contact Roles — deal Contact Roles get Deal Contact Role For Contact — response body — data data item

Deal Contact Roles — deal Contact Roles get Deal Contact Role For Contact — response body — data data item
FieldTypePresenceDescription and constraints
$objectRootContact role record with dynamic fields based on the 'fields' query parameter
Additional keys: allowed
Contact_RoleobjectOptionalContact role information
Additional keys: not allowed
Contact_Role.idstringRequired within parentRole's unique identifier
Format: int64
Contact_Role.namestringRequired within parentRole name (e.g., Developer/Evaluator)
Maximum length: 255
DepartmentJSONOptional
Department (anyOf 1)stringAlternativeDepartment of the contact
Department (anyOf 2)nullAlternativeDepartment of the contact
OwnerobjectOptionalOwner information for the contact role
Additional keys: not allowed
Owner.emailstringOptionalOwner's email address
Format: email
Owner.idstringOptionalOwner's unique identifier
Format: int64
Owner.namestringOptionalOwner's display name
Maximum length: 255

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

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.