Skip to content

Zoho: List kiosk executions

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

← Kiosks execute operations · Get started

Operation zoho.getkioskexecutions

Provider route: GET /crm/v8/settings/kiosks/{kioskId}/executions. 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"]["getKioskExecutions"]>[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.getKioskExecutions(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_executions(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
queryobjectOptionalAdditional keys: not allowed
query.pageintegerOptionalFormat: int32
query.per_pageintegerOptionalFormat: int32
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 List kiosk executions — response body

Referenced models: List kiosk executions — response body

List kiosk executions — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents a paginated list of kiosk execution records along with pagination metadata.
Additional keys: not allowed
infoModelRequired within parentExpand List kiosk executions — response body — info
kiosk_executionsarrayRequired within parentContains the list of kiosk execution records returned for the specified kiosk.
Maximum items: 4
kiosk_executions[]ModelEach itemExpand List kiosk executions — response body — kiosk executions item

Referenced models: List kiosk executions — response body — kiosk executions item, List kiosk executions — response body — info

List kiosk executions — response body — kiosk executions item
FieldTypePresenceDescription and constraints
$objectRootRepresents an execution instance of a kiosk, including start and end timestamps, owner information, executable state details, and the execution record ID.
Additional keys: not allowed
Kiosk_End_TimestringRequired within parentThe timestamp indicating when the most recently executed state of the Kiosk ended, in ISO 8601 format. The response is sorted in descending order of this field, with the most recent executions listed first.
Maximum length: 255
Kiosk_Start_TimestringRequired within parentRepresents the date and time at which the kiosk execution record session began.
Maximum length: 255
OwnerModelRequired within parentExpand List kiosk executions — response body — kiosk executions item Owner
executable_infoModelRequired within parentExpand List kiosk executions — response body — kiosk executions item executable info
idstringRequired within parentThe unique identifier of the available transition.
Maximum length: 255

Referenced models: List kiosk executions — response body — kiosk executions item executable info, List kiosk executions — response body — kiosk executions item Owner

List kiosk executions — response body — info
FieldTypePresenceDescription and constraints
$objectRootRepresents pagination metadata for list responses, including the current page number, records per page, total count, and whether more records are available.
Additional keys: not allowed
countJSONRequired within parent
count (anyOf 1)integerAlternativeIndicates the number of kiosk execution records returned in the current page.
Format: int32
count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
more_recordsbooleanRequired within parentIndicates whether more execution records are available beyond the current page.

Possible values:
true - Additional execution records exist beyond the current page.
false - No additional execution records exist; the current page is the last.
pageJSONRequired within parent
page (anyOf 1)integerAlternativeIndicates the current page number in the paginated list of execution records.
Format: int32
page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
per_pageJSONRequired within parent
per_page (anyOf 1)integerAlternativeIndicates the maximum number of kiosk execution records returned per page.
Format: int32
per_page (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
List kiosk executions — response body — kiosk executions item executable info
FieldTypePresenceDescription and constraints
$objectRootContains information about the current state of the Kiosk execution and the transition that can be executed next.
Additional keys: not allowed
stateModelRequired within parentExpand Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state
transitionsarrayRequired within parentAn array of available next transitions from the current state. Each transition object contains the unique identifier of an available transition from the current state.
Maximum items: 1
transitions[]ModelEach itemExpand List kiosk executions — response body — kiosk executions item executable info transitions item

Referenced models: List kiosk executions — response body — kiosk executions item executable info transitions item, Retrieve the Preview of a Specified Kiosk — response body — kiosk preview item executable info state

List kiosk executions — response body — kiosk executions item Owner
FieldTypePresenceDescription and constraints
$objectRootContains information about the owner of the record who initiated this kiosk execution.
Additional keys: not allowed
idstringRequired within parentContains the unique identifier of the record owner in the preview.
Maximum length: 255
namestringRequired within parentRepresents the full name of the record owner in the preview.
Maximum length: 255
List kiosk executions — response body — kiosk executions item executable info transitions item
FieldTypePresenceDescription and constraints
$objectRootRepresents a minimal transition reference used in kiosk execution records, containing the transition ID.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the kiosk transition referenced in the execution record.
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

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