Skip to content

Zoho: Get a Specific Kiosk

Zoho kiosks.getKiosk: arguments, response, policy and SDK examples.

← Kiosks operations · Get started

Operation zoho.getkiosk

Provider route: GET /crm/v8/settings/kiosks/{kioskId}. 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["kiosks"]["getKiosk"]>[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.kiosks.getKiosk(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.get_kiosk(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.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 Get a Specific Kiosk — response body

Referenced models: Get a Specific Kiosk — response body

Get a Specific Kiosk — response body
FieldTypePresenceDescription and constraints
$objectRootRepresents the response payload for retrieving a specific kiosk by its identifier, including full workflow and configuration details.
Additional keys: not allowed
kiosksarrayRequired within parentContains the kiosk object retrieved by the specified identifier.
Maximum items: 1
kiosks[]ModelEach itemExpand Get All Kiosks — response body — kiosks item

Referenced models: Get All Kiosks — response body — kiosks item

Get All Kiosks — response body — kiosks item
FieldTypePresenceDescription and constraints
$objectRootRepresents a compact summary of a kiosk with core attributes, module references, current record module, status, ownership, and version details.
Additional keys: allowed
associatedbooleanRequired within parentIndicates whether the kiosk is associated with other CRM components. Possible values:
true - The kiosk is associated with other components.
false - The kiosk is not associated with other components.
chart_dataobjectOptionalContains the workflow visualization data for the kiosk, including chart-specific configuration.
Additional keys: allowed
created_byModelRequired within parentExpand Get All Kiosks — response body — kiosks item created by
created_timestringRequired within parentRepresents the creation timestamp of the kiosk.
Maximum length: 255
current_record_moduleJSONRequired within parentRepresents the module configured as the current record for the kiosk.
current_record_module (anyOf 1)ModelAlternativeExpand Get All Kiosks — response body — kiosks item current record module value
current_record_module (anyOf 2)nullAlternativeRepresents the null state when no current record module is configured for the kiosk.
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeRepresents the description of the kiosk. This value may be null if no description is provided.
Maximum length: 255
description (anyOf 2)nullAlternativeRepresents the description of the kiosk. This value may be null if no description is provided.
Maximum length: 255
group_api_namestringRequired within parentRepresents the unique group API name for the kiosk.
Maximum length: 255
group_idstringRequired within parentRepresents the unique identifier of the group to which the kiosk belongs.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the kiosk.
Maximum length: 255
modified_byModelRequired within parentExpand Get All Kiosks — response body — kiosks item modified by
modified_timestringRequired within parentRepresents the date and time when the kiosk was last modified.
Maximum length: 255
moduleModelRequired within parentExpand Get All Kiosks — response body — kiosks item module
namestringRequired within parentRepresents the name of the kiosk.
Maximum length: 255
sequence_numberJSONRequired within parent
sequence_number (anyOf 1)integerAlternativeRepresents the display order of the kiosk within its group.
Format: int32
sequence_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
statesarrayOptionalContains the list of workflow states defined for the kiosk.
Maximum items: 100
states[]objectEach itemRepresents a workflow state of the kiosk, including its name, identifier, and type.
Additional keys: allowed
statusstringRequired within parentRepresents the current status of the kiosk.
Maximum length: 255
transitionsarrayOptionalContains the list of workflow transitions defined for the kiosk.
Maximum items: 100
transitions[]objectEach itemRepresents a workflow transition of the kiosk, including its name and identifier.
Additional keys: allowed
version_detailsModelRequired within parentExpand Get All Kiosks — response body — kiosks item version details

Referenced models: Get All Kiosks — response body — kiosks item created by, Get All Kiosks — response body — kiosks item modified by, Get All Kiosks — response body — kiosks item module, Get All Kiosks — response body — kiosks item current record module value, Get All Kiosks — response body — kiosks item version details

Get All Kiosks — response body — kiosks item created by
FieldTypePresenceDescription and constraints
$objectRootRepresents the summary of the user who created the kiosk, including the user ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who created the kiosk.
Maximum length: 255
namestringRequired within parentRepresents the name of the user who created the kiosk.
Maximum length: 255
Get All Kiosks — response body — kiosks item modified by
FieldTypePresenceDescription and constraints
$objectRootRepresents the summary of the user who last modified the kiosk, including the user ID and display name.
Additional keys: not allowed
idstringRequired within parentRepresents the unique identifier of the user who last modified the kiosk.
Maximum length: 255
namestringRequired within parentRepresents the name of the user who last modified the kiosk.
Maximum length: 255
Get All Kiosks — response body — kiosks item module
FieldTypePresenceDescription and constraints
$objectRootRepresents the reference to the CRM module configured for the kiosk, including the API name and identifier.
Additional keys: not allowed
api_namestringRequired within parentRepresents the API name of the module configured for the kiosk.
Maximum length: 255
idstringRequired within parentRepresents the unique identifier of the module configured for the kiosk.
Maximum length: 255
Get All Kiosks — response body — kiosks item current record module value
FieldTypePresenceDescription and constraints
$JSONRoot
$ (anyOf 1)objectAlternativeRepresents a summary of the module assigned as the current record for the kiosk, including the plural label, API name, and identifier.
Additional keys: not allowed
$ (anyOf 1).api_namestringRequired within parentRepresents the API name of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 1).idstringRequired within parentRepresents the unique identifier of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 1).plural_labelstringRequired within parentRepresents the plural display label of the current record module.
Maximum length: 255
$ (anyOf 2)nullAlternativeRepresents a summary of the module assigned as the current record for the kiosk, including the plural label, API name, and identifier.
Additional keys: not allowed
$ (anyOf 2).api_namestringRequired within parentRepresents the API name of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 2).idstringRequired within parentRepresents the unique identifier of the current record module configured for the kiosk.
Maximum length: 255
$ (anyOf 2).plural_labelstringRequired within parentRepresents the plural display label of the current record module.
Maximum length: 255
Get All Kiosks — response body — kiosks item version details
FieldTypePresenceDescription and constraints
$objectRootRepresents the versioning metadata for a kiosk, including the parent version identifier and the version number.
Additional keys: not allowed
parent_idnullRequired within parentRepresents the identifier of the parent kiosk version. This value is null for the initial version.
version_numberJSONRequired within parent
version_number (anyOf 1)integerAlternativeRepresents the version number of the kiosk.
Format: int32
version_number (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

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