Zoho: Retrieve the Preview of a Specified Kiosk
Zoho kiosksExecute.previewKiosk: arguments, response, policy and SDK examples.
← Kiosks execute operations · Get started
Operation zoho.previewkiosk
Provider route: GET /crm/v8/settings/kiosks/{kioskId}/actions/preview. 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["kiosksExecute"]["previewKiosk"]>[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.kiosksExecute.previewKiosk(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_execute.preview_kiosk(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: 19 |
query | object | Optional | Additional keys: not allowed |
query.current_record_id | string | Optional | Format: int64 |
query.invoked_from | string | Optional | One of: detail_view, home_page, cscript, canvas |
query.include_inner_details | string | Optional | Maximum length: 500 |
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 Retrieve the Preview of a Specified Kiosk — response body |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body
Schemas
Section titled “Schemas”11 more schemas are linked from the tables above, on the schema pages.
Retrieve the Preview of a Specified Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response for a successful kiosk preview, returning the initial executable screen with associated data, transitions, and layout metadata. Additional keys: not allowed |
kiosk_preview | array | Required within parent | Contains the preview details for the initial executable screen, including elements, transitions, data, and layout. Maximum items: 1 |
kiosk_preview[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the preview screen for a kiosk state, including executable information, prior states, elements, data, layout width, screen title, and button alignment. Additional keys: not allowed |
button_align | string | Required within parent | The alignment of action buttons. **Possible values:** **right_to_left** - Buttons are aligned from right to left. **left_to_right** - Buttons are aligned from left to right. **center** - Buttons are aligned to the center. Maximum length: 255 |
data | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data |
elements | array | Required within parent | Contains the list of elements rendered on the kiosk preview screen. Maximum items: 2 |
elements[] | JSON | Each item | Represents one element rendered on the kiosk preview screen, such as a record retrieval block or a form field. |
elements[] (anyOf 1) | Model | Alternative | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value |
elements[] (anyOf 2) | Model | Alternative | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value |
executable_info | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info |
kiosk | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk |
previous_states | array | Required within parent | Specifies an array containing the states traversed before the current state in the Kiosk execution flow. The states are listed in the order they were executed, starting from the start state and ending with the state immediately preceding the current state. Maximum items: 2 |
previous_states[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item |
title | string | Required within parent | Represents the display title of the kiosk preview screen. Maximum length: 255 |
width | string | Required within parent | Indicates the display width of the kiosk preview screen. Maximum length: 255 |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item previous states item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Contains the records retrieved by the data elements configured in the Kiosk. This object uses dynamic keys, where each key is the API name of a data element (for example, a Get Records element). Each key maps to an object containing the retrieved record's display name (name) and unique identifier (id). Additional keys: not allowed |
GetRecords_1 | array | Required within parent | Contains the list of record summaries returned by the GetRecords_1 element in the preview screen. Maximum items: 1 |
GetRecords_1[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item data Get Records 1 item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a preview element data block that aggregates record retrieval configuration, raw values, record data, and pagination flags for a get record element. Additional keys: not allowed |
get_record | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record |
get_record_data | array | Required within parent | Contains the list of CRM records returned by the get record element in the preview screen. Maximum items: 19 |
get_record_data[] | JSON | Each item | Represents a single CRM record entry returned by the get record element, including key field values and owner details. |
get_record_data[] (anyOf 1) | Model | Alternative | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id |
more_records | boolean | Required within parent | Indicates whether additional CRM records are available beyond those returned in the current preview response. Possible values: true - More records are available and can be retrieved. false - All available records have been returned in the current response. |
type | string | Required within parent | Indicates the type classification of the preview element data block. Maximum length: 255 |
value | null | Required within parent | Contains the value of the preview element data block, which may be null when the block uses a record retrieval configuration. |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item get record, get record data, more records, type, value get record data item Company, First Name, Owner, id
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Provides the current state and available transitions for the executable context of a kiosk preview. Additional keys: not allowed |
state | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state |
transitions | array | Required within parent | Specifies the list of transitions available from the current state. Each transition contains the display name, unique ID, prop_name,is_connected_end. Maximum items: 1 |
transitions[] | Model | Each item | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a field-based element within the kiosk preview screen, including its type classification and current value. Additional keys: not allowed |
field | Model | Required within parent | Expand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field |
type | string | Required within parent | Indicates the type classification of the field-based element in the preview screen. Maximum length: 255 |
value | string | Required within parent | Contains the current value of the field-based element in the preview screen. Maximum length: 255 |
Referenced models: Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item elements item field, type, value field
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a minimal summary of the kiosk in the preview, including the kiosk name and ID. Additional keys: not allowed |
id | string | Required within parent | Contains the unique identifier of the kiosk associated with the preview. Maximum length: 255 |
name | string | Required within parent | Represents the display name of the kiosk associated with the preview. Maximum length: 255 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.previewkiosk. Catalog operation: previewKiosk. 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.