Skip to content

Zoho: Retrieve a kiosk execution record

Zoho kiosksExecute.getKioskExecution: arguments, response, policy and SDK examples.

← Kiosks execute operations · Get started

Operation zoho.getkioskexecution

Provider route: GET /crm/v8/settings/kiosks/{kioskId}/executions/{executionId}. 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["kiosksExecute"]["getKioskExecution"]>[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.getKioskExecution(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_execute.get_kiosk_execution(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: 19
path.executionIdstringRequired within parentMaximum length: 19
queryobjectOptionalAdditional keys: not allowed
query.include_inner_detailsstringOptionalMaximum length: 500
query.navigated_from_backbooleanOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve a kiosk execution record — response body

Referenced models: Retrieve a kiosk execution record — response body

Retrieve a kiosk execution record — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the response for a specific kiosk execution state view, containing the elements and metadata for the state being executed.
Additional keys: not allowed
kiosk_executionsarrayRequired within parentContains the details of the execution state being rendered, including elements, layout, and data.
Maximum items: 1
kiosk_executions[]ModelEach itemExpand Retrieve a kiosk execution record — response body — kiosk executions item

Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item

Retrieve a kiosk execution record — response body — kiosk executions item
FieldTypePresenceDescription and constraints
$objectRootRepresents the screen and data for a specific execution state, including elements, layout dimensions, screen title, kiosk details, and executable information.
Additional keys: not allowed
button_alignJSONRequired within parent
button_align (anyOf 1)stringAlternativeThe 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.
Known values: right_to_left, left_to_right, center
Maximum length: 255
button_align (anyOf 2)nullAlternativeThe 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.
Known values: right_to_left, left_to_right, center
Maximum length: 255
dataModelRequired within parentExpand Retrieve a kiosk execution record — response body — kiosk executions item data
elementsarrayRequired within parentAn array of UI elements and data sources configured in the Kiosk. Each element has a type field that determines its structure.
Maximum items: 1
elements[]ModelEach itemExpand Retrieve a kiosk execution record — response body — kiosk executions item elements item
executable_infoModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info
idstringRequired within parentContains the unique identifier of the kiosk execution view record.
Maximum length: 255
kioskModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item kiosk
titlestringRequired within parentRepresents the display title of the kiosk execution state screen.
Maximum length: 255
widthJSONRequired within parent
width (anyOf 1)stringAlternativeIndicates the display width of the kiosk execution state screen.
Known values: 670px, 1000px
Maximum length: 255
width (anyOf 2)nullAlternativeIndicates the display width of the kiosk execution state screen.
Known values: 670px, 1000px
Maximum length: 255

Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item data, Retrieve a kiosk execution record — response body — kiosk executions item elements item, 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 kiosk

Retrieve a kiosk execution record — response body — kiosk executions item data
FieldTypePresenceDescription and constraints
$objectRootContains the runtime data available during the Kiosk execution. This object includes system-generated values (such as execution details, owner information, and record references) along with dynamically generated key-value pairs. The dynamic keys correspond to the API names of the configured Kiosk fields, GetRecords elements, and other runtime values available in the current execution. The fields returned vary depending on the Kiosk configuration and the execution context.
Additional keys: not allowed
Kiosk_End_TimestringRequired within parentRepresents the date and time at which the kiosk execution session ended.
Maximum length: 255
Kiosk_Start_TimestringRequired within parentRepresents the date and time at which the kiosk execution session began.
Maximum length: 255
OwnerModelRequired within parentExpand Retrieve a kiosk execution record — response body — kiosk executions item data Owner
idstringRequired within parentContains the unique identifier for the kiosk execution instance.
Maximum length: 255

Referenced models: Retrieve a kiosk execution record — response body — kiosk executions item data Owner

Retrieve a kiosk execution record — response body — kiosk executions item elements item
FieldTypePresenceDescription and constraints
$objectRootRepresents a simple element associated with a kiosk execution, including its type classification and associated value.
Additional keys: not allowed
typestringRequired within parentIndicates the type classification of the execution element.
Maximum length: 255
valuestringRequired within parentContains the value associated with the execution element.
Maximum length: 255
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info
FieldTypePresenceDescription and constraints
$objectRootProvides the current state and available transitions for the executable context of a kiosk preview.
Additional keys: not allowed
stateModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
transitionsarrayRequired within parentSpecifies 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[]ModelEach itemExpand 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 kiosk
FieldTypePresenceDescription and constraints
$objectRootRepresents a minimal summary of the kiosk in the preview, including the kiosk name and ID.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the kiosk associated with the preview.
Maximum length: 255
namestringRequired within parentRepresents the display name of the kiosk associated with the preview.
Maximum length: 255
Retrieve a kiosk execution record — response body — kiosk executions item data Owner
FieldTypePresenceDescription and constraints
$objectRootRepresents detailed owner information for a kiosk execution, including name, ID, and email address.
Additional keys: not allowed
emailstringRequired within parentRepresents the email address of the owner associated with the kiosk execution.
Maximum length: 255
idstringRequired within parentContains the unique identifier of the owner associated with the kiosk execution.
Maximum length: 255
namestringRequired within parentRepresents the full name of the owner associated with the kiosk execution.
Maximum length: 255
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
FieldTypePresenceDescription and constraints
$objectRootRepresents a summary of a kiosk state referenced in the preview, including the state ID and display name.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the kiosk state referenced in the preview.
Maximum length: 255
namestringRequired within parentRepresents the display name of the kiosk state referenced in the preview.
Maximum length: 255
Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info transitions item
FieldTypePresenceDescription and constraints
$objectRootDescribes a transition in the kiosk preview, including the connection flag, display name, ID, and property name of the transition button.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the transition in the kiosk preview.
Maximum length: 255
is_connected_endbooleanRequired within parentIndicates whether this transition leads to a connected end state in the kiosk flow.

Possible values:
true - The transition leads to a connected end state.
false - The transition leads to an intermediate state in the kiosk flow.
namestringRequired within parentRepresents the display name of the transition in the kiosk preview.
Maximum length: 255
prop_namestringRequired within parentSpecifies the type of button displayed on the Kiosk screen. Each button corresponds to a transition path that the user can select from the current screen.
**Possible values:**

**primary** - Displays the button as the primary action on the screen, typically used for actions such as Next, Submit, or Save.

**default** - Displays the button with the standard appearance, suitable for secondary actions.

**outlineprimary** - Displays the button with a primary-colored outline, emphasizing the action without making it the primary button.

**failure** - Displays the button with a solid error-themed style, typically used for destructive or critical actions such as Delete or Reject.

**outlineredlight** - Displays the button with a red outline, typically used for secondary destructive actions such as Cancel, Discard, or Remove.

Known values: primary, default, outlineprimary, failure, outlineredlight
Maximum length: 255

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