Zoho: Get All Kiosks
Zoho kiosks.getAllKiosks: arguments, response, policy and SDK examples.
← Kiosks operations · Get started
Operation zoho.getallkiosks
Provider route: GET /crm/v8/settings/kiosks. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["getAllKiosks"]>[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.getAllKiosks(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_all_kiosks(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.include_inner_details | string | Optional | Maximum length: 500 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get All Kiosks — response body |
Referenced models: Get All Kiosks — response body
Schemas
Section titled “Schemas”Get All Kiosks — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the response payload delivering detailed information for a specific kiosk, including workflow and configuration data. Additional keys: not allowed |
kiosks | array | Required within parent | Contains the list of kiosk objects with detailed information. Maximum items: 50 |
kiosks[] | Model | Each item | Expand Get All Kiosks — response body — kiosks item |
Referenced models: Get All Kiosks — response body — kiosks item
Get All Kiosks — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents a compact summary of a kiosk with core attributes, module references, current record module, status, ownership, and version details. Additional keys: allowed |
associated | boolean | Required within parent | Indicates 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_data | object | Optional | Contains the workflow visualization data for the kiosk, including chart-specific configuration. Additional keys: allowed |
created_by | Model | Required within parent | Expand Get All Kiosks — response body — kiosks item created by |
created_time | string | Required within parent | Represents the creation timestamp of the kiosk. Maximum length: 255 |
current_record_module | JSON | Required within parent | Represents the module configured as the current record for the kiosk. |
current_record_module (anyOf 1) | Model | Alternative | Expand Get All Kiosks — response body — kiosks item current record module value |
current_record_module (anyOf 2) | null | Alternative | Represents the null state when no current record module is configured for the kiosk. |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Represents the description of the kiosk. This value may be null if no description is provided. Maximum length: 255 |
description (anyOf 2) | null | Alternative | Represents the description of the kiosk. This value may be null if no description is provided. Maximum length: 255 |
group_api_name | string | Required within parent | Represents the unique group API name for the kiosk. Maximum length: 255 |
group_id | string | Required within parent | Represents the unique identifier of the group to which the kiosk belongs. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the kiosk. Maximum length: 255 |
modified_by | Model | Required within parent | Expand Get All Kiosks — response body — kiosks item modified by |
modified_time | string | Required within parent | Represents the date and time when the kiosk was last modified. Maximum length: 255 |
module | Model | Required within parent | Expand Get All Kiosks — response body — kiosks item module |
name | string | Required within parent | Represents the name of the kiosk. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Represents the display order of the kiosk within its group. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
states | array | Optional | Contains the list of workflow states defined for the kiosk. Maximum items: 100 |
states[] | object | Each item | Represents a workflow state of the kiosk, including its name, identifier, and type. Additional keys: allowed |
status | string | Required within parent | Represents the current status of the kiosk. Maximum length: 255 |
transitions | array | Optional | Contains the list of workflow transitions defined for the kiosk. Maximum items: 100 |
transitions[] | object | Each item | Represents a workflow transition of the kiosk, including its name and identifier. Additional keys: allowed |
version_details | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary of the user who created the kiosk, including the user ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the user who created the kiosk. Maximum length: 255 |
name | string | Required within parent | Represents the name of the user who created the kiosk. Maximum length: 255 |
Get All Kiosks — response body — kiosks item modified by
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the summary of the user who last modified the kiosk, including the user ID and display name. Additional keys: not allowed |
id | string | Required within parent | Represents the unique identifier of the user who last modified the kiosk. Maximum length: 255 |
name | string | Required within parent | Represents the name of the user who last modified the kiosk. Maximum length: 255 |
Get All Kiosks — response body — kiosks item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the reference to the CRM module configured for the kiosk, including the API name and identifier. Additional keys: not allowed |
api_name | string | Required within parent | Represents the API name of the module configured for the kiosk. Maximum length: 255 |
id | string | Required within parent | Represents the unique identifier of the module configured for the kiosk. Maximum length: 255 |
Get All Kiosks — response body — kiosks item current record module value
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | object | Alternative | Represents 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_name | string | Required within parent | Represents the API name of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 1).id | string | Required within parent | Represents the unique identifier of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 1).plural_label | string | Required within parent | Represents the plural display label of the current record module. Maximum length: 255 |
$ (anyOf 2) | null | Alternative | Represents 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_name | string | Required within parent | Represents the API name of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 2).id | string | Required within parent | Represents the unique identifier of the current record module configured for the kiosk. Maximum length: 255 |
$ (anyOf 2).plural_label | string | Required within parent | Represents the plural display label of the current record module. Maximum length: 255 |
Get All Kiosks — response body — kiosks item version details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the versioning metadata for a kiosk, including the parent version identifier and the version number. Additional keys: not allowed |
parent_id | null | Required within parent | Represents the identifier of the parent kiosk version. This value is null for the initial version. |
version_number | JSON | Required within parent | |
version_number (anyOf 1) | integer | Alternative | Represents the version number of the kiosk. Format: int32 |
version_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getallkiosks. Catalog operation: getAllKiosks. 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.