Skip to content

Zoho: Get a specific kiosk state by ID

Zoho kiosksStates.getKioskState: arguments, response, policy and SDK examples.

← Kiosks states operations · Get started

Operation zoho.getkioskstate

Provider route: GET /crm/v8/settings/kiosks/{kioskId}/states/{stateId}. 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["kiosksStates"]["getKioskState"]>[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.kiosksStates.getKioskState(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_states.get_kiosk_state(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.stateIdstringRequired within parentMaximum length: 255
queryobjectOptionalAdditional keys: not allowed
query.include_inner_detailsstringOptionalOne of: details.type
query.includestringOptionalOne of: configured_properties

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get a specific kiosk state by ID — response body

Referenced models: Get a specific kiosk state by ID — response body

52 more schemas are linked from the tables above, on the schema pages.

Get a specific kiosk state by ID — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the response for retrieving a specific kiosk state. The state details structure varies by type and can be a screen, decision, action, or get_records state.
Additional keys: not allowed
statesarrayRequired within parentRepresents the list of states returned for the kiosk.
Maximum items: 1
states[]JSONEach itemRepresents a single kiosk state, either a screen, decision, action, or get_records state, with its full configuration details.
states[] (anyOf 1)ModelAlternativeExpand Get a specific kiosk state by ID — response body — states / item / type: screen
states[] (anyOf 2)ModelAlternativeExpand Get a specific kiosk state by ID — response body — states / item / type: decision
states[] (anyOf 3)ModelAlternativeExpand Get a specific kiosk state by ID — response body — states / item / type: action
states[] (anyOf 4)ModelAlternativeExpand Get a specific kiosk state by ID — response body — states / item / type: get records

Referenced models: Get a specific kiosk state by ID — response body — states / item / type: action, Get a specific kiosk state by ID — response body — states / item / type: decision, Get a specific kiosk state by ID — response body — states / item / type: get records, Get a specific kiosk state by ID — response body — states / item / type: screen

Get a specific kiosk state by ID — response body — states / item / type: action
FieldTypePresenceDescription and constraints
$objectRootRepresents a single action state returned by the get-by-ID endpoint, including the action configuration, associated fields, transitions, and configured properties.
Additional keys: not allowed
associated_fieldsJSONRequired within parent
associated_fields (anyOf 1)arrayAlternativeRepresents the list of fields associated with the action state.
Maximum items: 25
associated_fields (anyOf 1)[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item
associated_fields (anyOf 2)nullAlternativeRepresents the list of fields associated with the action state.
Maximum items: 25
associated_fields (anyOf 2)[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item
configured_propertiesJSONOptional
configured_properties (anyOf 1)objectAlternativeRepresents additional configured properties returned for the action state.
Additional keys: allowed
configured_properties (anyOf 2)nullAlternativeRepresents additional configured properties returned for the action state.
Additional keys: allowed
detailsobjectRequired within parentRepresents the detailed action configuration for the kiosk action state.
Additional keys: allowed
from_transitionModelOptionalExpand Get a specific kiosk state by ID — response body — states / item / type: action from transition
Transition that leads into this action state.
idstringRequired within parentRepresents the unique identifier of the kiosk action state.
Maximum length: 255
namestringRequired within parentRepresents the name of the kiosk action state.
Maximum length: 255
transitionsarrayRequired within parentRepresents the list of outgoing transitions configured for the kiosk action state.
Maximum items: 25
transitions[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: action from transition
typestringRequired within parentRepresents the type of the kiosk state.
Known values: action
Maximum length: 255

Referenced models: Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item, Get a specific kiosk state by ID — response body — states / item / type: action from transition

Get a specific kiosk state by ID — response body — states / item / type: decision
FieldTypePresenceDescription and constraints
$objectRootRepresents a single decision state returned by the get-by-ID endpoint, including its configuration, associated fields, transitions, and configured properties.
Additional keys: not allowed
associated_fieldsarrayRequired within parentRepresents the list of fields associated with the decision state, including the paths that reference each field.
Maximum items: 30
associated_fields[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item
configured_propertiesarrayRequired within parentRepresents the list of configured properties associated with the decision state.
Maximum items: 30
configured_properties[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item
detailsModelRequired within parentExpand Get a specific kiosk state by ID — response body — states / item / type: decision details
from_transitionModelRequired within parentExpand Get a specific kiosk state by ID — response body — states / item / type: screen from transition
idstringRequired within parentRepresents the unique identifier of the kiosk decision state.
Maximum length: 255
namestringRequired within parentRepresents the display name of the kiosk decision state.
Maximum length: 255
transitionsarrayRequired within parentRepresents the list of outgoing transitions configured for the decision state.
Maximum items: 30
transitions[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: decision transitions item
typestringRequired within parentRepresents the type of the kiosk state. Always 'decision' for this schema.
Known values: decision
Maximum length: 255

Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item, Get a specific kiosk state by ID — response body — states / item / type: decision transitions item, Get a specific kiosk state by ID — response body — states / item / type: screen from transition, Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item, Get a specific kiosk state by ID — response body — states / item / type: decision details

Get a specific kiosk state by ID — response body — states / item / type: screen associated fields item
FieldTypePresenceDescription and constraints
$objectRootRepresents a field associated with a kiosk state, including its API name and unique identifier.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the field associated with the kiosk state.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the field associated with the kiosk state.
Maximum length: 255
typestringOptionalField: type. Present only for screen state associated fields.
Maximum length: 255
Get a specific kiosk state by ID — response body — states / item / type: action from transition
FieldTypePresenceDescription and constraints
$objectRootRepresents an outgoing transition from a kiosk state returned in a GET response. Contains the transition ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the outgoing transition.
Maximum length: 255
namestringRequired within parentRepresents the display name of the outgoing transition.
Maximum length: 255
Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item
FieldTypePresenceDescription and constraints
$objectRootRepresents a field associated with a decision state, including its API name, unique identifier, and the decision paths that reference it.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the field associated with the decision state.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the field associated with the decision state.
Maximum length: 255
path_detailsarrayOptionalRepresents the list of decision paths that reference this associated field.
Maximum items: 11
path_details[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item path details item

Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision associated fields item path details item

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