Zoho: Kiosk Get Record — kiosks Get Records create Kiosk Get Record
Zoho kiosksGetRecords.createKioskGetRecord: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.createkioskgetrecord
Provider route: POST /crm/v8/settings/kiosks/{kioskId}/get_records. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["kiosksGetRecords"]["createKioskGetRecord"]>[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.createKioskGetRecord(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.create_kiosk_get_record(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.kioskId | string | Required within parent | Maximum length: 255 |
body | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body
Response
Section titled “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 |
|---|---|---|---|
$ | Model | Root | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body
Schemas
Section titled “Schemas”18 more schemas are linked from the tables above, on the schema pages.
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for creating a new get_record component. Additional keys: not allowed |
get_records | array | Required within parent | Array containing the get_record configuration to create. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response after successfully creating a get_record component. Additional keys: not allowed |
get_records | array | Optional | Array of operation results. Maximum items: 1 |
get_records[] | Model | Each item | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Payload for creating a get_record component. Defines the module, criteria, selection rules, and sort order. Additional keys: not allowed |
child_relationship | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item child relationship Reference to the child relationship. Used when type is 'child'. |
criteria | Model | Required within parent | Expand Related Records — request body — query filters Filter criteria configuration for selecting records. Supports both simple field-based filters and grouped conditions with logical operators (AND/OR). MANDATORY type key is required inside criteria even if it's not mentioned in the schema |
module | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module Module from which records will be fetched. |
name | string | Required within parent | Human-readable name of the get_record component. Must be unique within the kiosk. Maximum length: 50 |
parent_record_field | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item parent record field Reference to the parent module field. Required when type is 'child'. |
selected_fields | array or null | Optional | Fields to display when the get_record is shown on a screen. Only needed when associated with a screen state. Maximum items: 50 |
selected_fields[] | string | Each item | API name of a selected field. Maximum length: 30 |
selection_details | Model | Optional | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item selection details Selection rules controlling how many records are fetched and how users can select from them. |
sort_order | Model | Required within parent | Expand Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order Sort order configuration for fetched records. order_by_name is always required. When order_by_name is 'not_sort', order_by_field must not be present. Otherwise, order_by_field is required and its 'id' key must be provided |
type | string or null | Optional | Module type: 'parent' for direct modules (e.g., Leads) or 'child' for related modules (e.g., Calls). One of: parent, child |
Referenced models: Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item child relationship, Related Records — request body — query filters, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item parent record field, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item selection details, Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item sort order
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — response body — get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Operation result for get_record CRUD operations. Additional keys: not allowed |
code | string | Optional | Result code (e.g., 'SUCCESS'). Maximum length: 255 |
details | Model | Optional | Expand Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details |
message | string | Optional | Human-readable result message. Maximum length: 255 |
status | string | Optional | Status of the operation (e.g., 'success'). Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records update Kiosk Associations — response body — kiosks item details
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item child relationship
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the child relationship (e.g., Calls, Tasks) for child-type get_records. Additional keys: not allowed |
display_label | string or null | Optional | Display label of the child relationship. Maximum length: 50 |
id | string | Required within parent | Unique identifier of the child relationship. Maximum length: 19 |
Related Records — request body — query filters
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the top-level filter criterion for data selection, supporting both simple field-based filters and complex grouped filters with logical operators. |
$ (anyOf 1) | Model | Alternative | Expand Related Records — request body — query filters value |
$ (anyOf 2) | Model | Alternative | Expand Related Records — request body — query / filters / group_operator: AND, OR, and, or |
Referenced models: Related Records — request body — query / filters / group_operator: AND, OR, and, or, Related Records — request body — query filters value
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module reference with required ID for identifying the CRM module. Additional keys: not allowed |
api_name | string or null | Optional | API name of the module. Maximum length: 50 |
id | string | Required within parent | Unique identifier of the module. Maximum length: 19 |
name | string or null | Optional | Display name of the module. Maximum length: 50 |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item parent record field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Reference to the parent module's record field. Required when the get_record type is 'child'. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the parent record field. Maximum length: 19 |
Kiosk Get Record — kiosks Get Records create Kiosk Get Record — request body — body get records item selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selection rules for controlling record fetching and user selection during kiosk execution. Rules by result_type - 'multiple': range and selection_type are mandatory; range value must be strictly greater than limit. 'all': selection_type and limit are mandatory; range must NOT be provided. 'single': selection_type must not be provided (must be null); range and limit must both be sent as 1. Additional keys: not allowed |
limit | integer or null | Optional | Maximum number of records the user can select. Must be less than range when result_type is 'multiple'. Mandatory when result_type is 'all'. Must be 1 when result_type is 'single'. Format: int32 |
range | integer or null | Optional | Maximum number of records to fetch. Mandatory when result_type is 'multiple' (must be greater than limit). Must be 1 when result_type is 'single'. Must NOT be provided when result_type is 'all'. Format: int32 |
result_type | string | Required within parent | Determines how many records are fetched. 'multiple': range and selection_type are mandatory; range must be greater than limit. 'all': selection_type and limit are mandatory; range must NOT be sent. 'single': range and limit must both be 1; selection_type must not be sent (must be null). One of: single, multiple, all Maximum length: 10 |
selection_type | string or null | Optional | User selection behavior: 'mandate' (required), 'optional', or 'read_only'. Mandatory when result_type is 'multiple' or 'all'. Must be null (not provided) when result_type is 'single'. One of: mandate, optional, read_only |
$ (allOf 1) | JSON | All variants apply | |
$ (allOf 2) | JSON | All variants apply | |
$ (allOf 3) | JSON | All variants apply |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.createkioskgetrecord. Catalog operation: createKioskGetRecord. 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.