Zoho: Deal Contact Roles — deal Contact Roles get Associated Contact Roles

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

← Deal contact roles operations · Get started

Operation zoho.getassociatedcontactroles

Provider route: GET /crm/v8/{module}/{dealId}/Contact_Roles. 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["dealContactRoles"]["getAssociatedContactRoles"]>[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.getAssociatedContactRoles(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_associated_contact_roles(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.module`	string	Required within parent	One of: Deals
`path.dealId`	string	Required within parent	Format: int64
`query`	object	Required within parent	Additional keys: not allowed
`query.fields`	string	Required within parent	Maximum length: 1000 Minimum length: 1 Pattern: ^[A-Za-z_][A-Za-z0-9_](?:,[A-Za-z_][A-Za-z0-9_])*$

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	Response containing contact roles data and pagination details. Additional keys: not allowed
`$ (anyOf 1).data`	array	Required within parent	Array of contact role records with fields specified in the query parameter Maximum items: 100
`$ (anyOf 1).data[]`	Model	Each item	Expand Deal Contact Roles — deal Contact Roles get Deal Contact Role For Contact — response body — data data item
`$ (anyOf 1).info`	object	Required within parent	Pagination and response metadata Additional keys: not allowed
`$ (anyOf 1).info.count`	JSON	Required within parent
`$ (anyOf 1).info.count (anyOf 1)`	integer	Alternative	Number of records in the current response Format: int32
`$ (anyOf 1).info.count (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.more_records`	boolean	Required within parent	Indicates if more records are available
`$ (anyOf 1).info.next_page_token`	JSON	Optional
`$ (anyOf 1).info.next_page_token (anyOf 1)`	string	Alternative	Token for retrieving the next page of results Maximum length: 1024
`$ (anyOf 1).info.next_page_token (anyOf 2)`	null	Alternative	Token for retrieving the next page of results Maximum length: 1024
`$ (anyOf 1).info.page`	JSON	Required within parent
`$ (anyOf 1).info.page (anyOf 1)`	integer	Alternative	Current page number Format: int32
`$ (anyOf 1).info.page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.page_token_expiry`	JSON	Optional
`$ (anyOf 1).info.page_token_expiry (anyOf 1)`	string	Alternative	Expiry timestamp for page tokens Maximum length: 1024
`$ (anyOf 1).info.page_token_expiry (anyOf 2)`	null	Alternative	Expiry timestamp for page tokens Maximum length: 1024
`$ (anyOf 1).info.per_page`	JSON	Required within parent
`$ (anyOf 1).info.per_page (anyOf 1)`	integer	Alternative	Number of records per page Format: int32
`$ (anyOf 1).info.per_page (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`$ (anyOf 1).info.previous_page_token`	JSON	Optional
`$ (anyOf 1).info.previous_page_token (anyOf 1)`	string	Alternative	Token for retrieving the previous page of results Maximum length: 1024
`$ (anyOf 1).info.previous_page_token (anyOf 2)`	null	Alternative	Token for retrieving the previous page of results Maximum length: 1024
`$ (anyOf 2)`	null	Alternative

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

Schemas

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

Field	Type	Presence	Description and constraints
`$`	object	Root	Contact role record with dynamic fields based on the 'fields' query parameter Additional keys: allowed
`Contact_Role`	object	Optional	Contact role information Additional keys: not allowed
`Contact_Role.id`	string	Required within parent	Role's unique identifier Format: int64
`Contact_Role.name`	string	Required within parent	Role name (e.g., Developer/Evaluator) Maximum length: 255
`Department`	JSON	Optional
`Department (anyOf 1)`	string	Alternative	Department of the contact
`Department (anyOf 2)`	null	Alternative	Department of the contact
`Owner`	object	Optional	Owner information for the contact role Additional keys: not allowed
`Owner.email`	string	Optional	Owner's email address Format: email
`Owner.id`	string	Optional	Owner's unique identifier Format: int64
`Owner.name`	string	Optional	Owner's display name Maximum length: 255

Policy, approvals and errors

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