Skip to content

Zoho: Get Records Associations

Zoho kiosksGetRecords.getKioskGetRecordAssociations: arguments, response, policy and SDK examples.

← Kiosks get records operations · Get started

Operation zoho.getkioskgetrecordassociations

Provider route: GET /crm/v8/settings/kiosks/{kioskId}/get_records/{getRecordId}/associations. 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["kiosksGetRecords"]["getKioskGetRecordAssociations"]>[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.kiosksGetRecords.getKioskGetRecordAssociations(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.kiosks_get_records.get_kiosk_get_record_associations(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.kioskIdstringRequired within parentMaximum length: 255
path.getRecordIdstringRequired within parentMaximum length: 255
queryobjectOptionalAdditional keys: not allowed
query.include_inner_detailsstringOptionalMaximum length: 500

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get Records Associations — response body

Referenced models: Get Records Associations — response body

Get Records Associations — response body
FieldTypePresenceDescription and constraints
$objectRootResponse containing get_record association information.
Additional keys: not allowed
get_recordsarrayRequired within parentArray of get_record association data.
Maximum items: 10
get_records[]ModelEach itemExpand Get Records Associations — response body — get records item

Referenced models: Get Records Associations — response body — get records item

Get Records Associations — response body — get records item
FieldTypePresenceDescription and constraints
$objectRootGet record with its association information.
Additional keys: not allowed
_associationsarrayRequired within parentList of associations for this get_record.
Maximum items: 10
_associations[]ModelEach itemExpand Get Records Associations — response body — get records item associations item
idstringRequired within parentGet record identifier.
Maximum length: 19

Referenced models: Get Records Associations — response body — get records item associations item

Get Records Associations — response body — get records item associations item
FieldTypePresenceDescription and constraints
$objectRootAssociation entry describing where a component is used.
Additional keys: not allowed
resourcesarrayRequired within parentResources that use this component.
Maximum items: 25
resources[]ModelEach itemExpand Get Records Associations — response body — get records item associations item resources item
typestringRequired within parentType of association (e.g., 'kiosk_states').
Maximum length: 255

Referenced models: Get Records Associations — response body — get records item associations item resources item

Get Records Associations — response body — get records item associations item resources item
FieldTypePresenceDescription and constraints
$objectRootResource that references a component.
Additional keys: not allowed
_detailsModelRequired within parentExpand Get Records Associations — response body — get records item associations item resources item details
idstringRequired within parentUnique identifier of the resource.
Maximum length: 255
namestringRequired within parentName of the resource.
Maximum length: 255

Referenced models: Get Records Associations — response body — get records item associations item resources item details

Get Records Associations — response body — get records item associations item resources item details
FieldTypePresenceDescription and constraints
$objectRootDetails about the resource type.
Additional keys: not allowed
typestringRequired within parentType of the resource (e.g., 'get_records', 'action').
Maximum length: 255

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

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.