Skip to content

Zoho: Get all states of a kiosk

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

← Kiosks states operations · Get started

Operation zoho.getallkioskstates

Provider route: GET /crm/v8/settings/kiosks/{kioskId}/states. 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"]["getAllKioskStates"]>[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.getAllKioskStates(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_all_kiosk_states(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
queryobjectOptionalAdditional keys: not allowed
query.includestringOptionalOne of: configured_properties
query.include_inner_detailsstringOptionalOne of: details.type

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

FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Get all states of a kiosk — response body — states
$ (anyOf 2)nullAlternative

Referenced models: Get all states of a kiosk — response body — states

1 more schema is linked from the tables above, on the schema pages.

Get all states of a kiosk — response body — states
FieldTypePresenceDescription and constraints
$objectRootRepresents the response for retrieving all states associated with a kiosk. Contains a list of lightweight state entries with their basic metadata.
Additional keys: not allowed
statesarrayRequired within parentThe response body contains a JSON object with a states array that lists all the states configured in the specified Kiosk.
Maximum items: 150
states[]ModelEach itemExpand Get all states of a kiosk — response body — states states item

Referenced models: Get all states of a kiosk — response body — states states item

Get all states of a kiosk — response body — states states item
FieldTypePresenceDescription and constraints
$objectRootRepresents a lightweight kiosk state entry returned by the get all states operation. Includes the state ID, name, type, transitions, associated fields, and summary details.
Additional keys: not allowed
associated_fieldsJSONOptional
associated_fields (anyOf 1)arrayAlternativeRepresents the state type, indicating whether the state is a screen, decision, action, or get_records state. Below are the possible values for the action state.
**Possible values:**
create_record
quick_create_record
convert
open_record
open_link
add_meeting
schedule_call
assign_owner
add_tags
remove_tags
field_updates
tasks
email_notifications
webhooks

For get_records ,decision , start_state and end_state states, this field is null.

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 state type, indicating whether the state is a screen, decision, action, or get_records state. Below are the possible values for the action state.
**Possible values:**
create_record
quick_create_record
convert
open_record
open_link
add_meeting
schedule_call
assign_owner
add_tags
remove_tags
field_updates
tasks
email_notifications
webhooks

For get_records ,decision , start_state and end_state states, this field is null.

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)arrayAlternativeMerge fields and dynamic references. Returned only when the include parameter is used.
Maximum items: 50
configured_properties (anyOf 1)[]ModelEach itemExpand Get all states of a kiosk — response body — states states item configured properties null item
configured_properties (anyOf 2)nullAlternativeMerge fields and dynamic references. Returned only when the include parameter is used.
Maximum items: 50
configured_properties (anyOf 2)[]ModelEach itemExpand Get all states of a kiosk — response body — states states item configured properties null item
detailsModelOptionalExpand Get all states of a kiosk — response body — states states item details
from_transitionJSONOptional
from_transition (anyOf 1)objectAlternativeEntry transition details. Null for start states.
Additional keys: not allowed
from_transition (anyOf 1).idstringRequired within parentField: id
Maximum length: 255
from_transition (anyOf 1).namestringRequired within parentField: name
Maximum length: 255
from_transition (anyOf 2)nullAlternativeEntry transition details. Null for start states.
Additional keys: not allowed
from_transition (anyOf 2).idstringRequired within parentField: id
Maximum length: 255
from_transition (anyOf 2).namestringRequired within parentField: name
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the kiosk state.
Maximum length: 255
namestringRequired within parentRepresents the display name of the kiosk state.
Maximum length: 255
transitionsJSONOptional
transitions (anyOf 1)arrayAlternativeRepresents the list of outgoing transitions from the kiosk state.
Maximum items: 25
transitions (anyOf 1)[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: action from transition
transitions (anyOf 2)nullAlternativeRepresents the list of outgoing transitions from the kiosk state.
Maximum items: 25
transitions (anyOf 2)[]ModelEach itemExpand Get a specific kiosk state by ID — response body — states / item / type: action from transition
typestringRequired within parentRepresents the state type, indicating whether the state is a screen, decision, action, or get_records state.
Known values: start_state, screen, get_records, end_state, action, decision
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 all states of a kiosk — response body — states states item details, Get all states of a kiosk — response body — states states item configured properties null item

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 all states of a kiosk — response body — states states item details
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeRepresents the summary details object returned for a state by the get all states operation. Contains lightweight screen detail properties when available. The structure of this object depends on the state type.
Additional keys: not allowed
$ (anyOf 1).screen_detailsModelRequired within parentExpand Get all states of a kiosk — response body — states states item details screen details screen details
$ (anyOf 2)nullAlternativeRepresents the summary details object returned for a state by the get all states operation. Contains lightweight screen detail properties when available. The structure of this object depends on the state type.
Additional keys: not allowed
$ (anyOf 2).screen_detailsModelRequired within parentExpand Get all states of a kiosk — response body — states states item details screen details screen details

Referenced models: Get all states of a kiosk — response body — states states item details screen details screen details

Get all states of a kiosk — response body — states states item configured properties null item
FieldTypePresenceDescription and constraints
$objectRootRepresents a configured property associated with a screen state returned in a GET response. Contains the type and detail properties.
Additional keys: not allowed
detailsModelRequired within parentExpand Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details
typestringRequired within parentRepresents the type of the configured property associated with the screen state.
Known values: _merge_field, recipients
Maximum length: 255

Referenced models: Get a specific kiosk state by ID — response body — states / item / type: decision configured properties item details

Get all states of a kiosk — response body — states states item details screen details screen details
FieldTypePresenceDescription and constraints
$objectRootRepresents the summary screen details returned for a screen state by the get all states operation. Contains the width, title, and button alignment.
Additional keys: not allowed
button_alignstringRequired within parentRepresents the alignment direction of action buttons within the screen footer.
**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
titlestringRequired within parentRepresents the display title shown at the top of the kiosk screen.
Maximum length: 255
widthstringRequired within parentRepresents the visual width of the kiosk screen container.
**Possible values:**
**670px**
**1000px**

Known values: 670px, 1000px
Maximum length: 255

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

No-content response statuses: [204]

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.