Zoho: Kiosk Get Records
Zoho kiosksGetRecords.getAllKioskGetRecords: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.getallkioskgetrecords
Provider route: GET /crm/v8/settings/kiosks/{kioskId}/get_records. 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["kiosksGetRecords"]["getAllKioskGetRecords"]>[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.kiosksGetRecords.getAllKioskGetRecords(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_records.get_all_kiosk_get_records(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.kioskId | string | Required within parent | Maximum length: 255 |
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 |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a specific get record component from a Kiosk — response body |
$ (anyOf 2) | null | Alternative |
Referenced models: Retrieve a specific get record component from a Kiosk — response body
Schemas
Section titled “Schemas”15 more schemas are linked from the tables above, on the schema pages.
Retrieve a specific get record component from a Kiosk — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing all get_record components with their full configuration. Additional keys: not allowed |
get_records | array | Required within parent | Array of get_record component details. Maximum items: 25 |
get_records[] | Model | Each item | Expand Retrieve a specific get record component from a Kiosk — response body — get records item |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item
Retrieve a specific get record component from a Kiosk — response body — get records item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Complete get_record component data as returned in GET responses. Additional keys: not allowed |
criteria | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria Filter criteria configured for this get_record. |
id | string | Required within parent | Unique identifier of the get_record component. Maximum length: 19 |
module | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item module |
name | string | Required within parent | Name of the get_record component. Maximum length: 255 |
selected_fields | JSON | Required within parent | |
selected_fields (anyOf 1) | array | Alternative | Fields configured for display. Null if not configured. Maximum items: 50 |
selected_fields (anyOf 1)[] | string | Each item | API name of a selected field. Maximum length: 30 |
selected_fields (anyOf 2) | null | Alternative | Fields configured for display. Null if not configured. Maximum items: 50 |
selected_fields (anyOf 2)[] | string | Each item | API name of a selected field. Maximum length: 30 |
selection_details | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item selection details |
sort_order | Model | Required within parent | Expand Retrieve a specific get record component from a Kiosk — response body — get records item sort order |
type | string | Required within parent | Module type: 'parent' or 'child'. Maximum length: 255 |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item sort order, Retrieve a specific get record component from a Kiosk — response body — get records item module, Retrieve a specific get record component from a Kiosk — response body — get records item criteria, Retrieve a specific get record component from a Kiosk — response body — get records item selection details
Retrieve a specific get record component from a Kiosk — response body — get records item sort order
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Sort order information in GET responses. When order_by_name is 'not_sort', order_by_field is absent. Otherwise, order_by_field is present and its 'id' is required (enforced by GETOrderByField). Additional keys: not allowed |
order_by_field | Model | Optional | Expand Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field |
order_by_name | string | Required within parent | Sort direction. Maximum length: 255 |
$ (allOf 1) | JSON | All variants apply |
Referenced models: Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field
Retrieve a specific get record component from a Kiosk — response body — get records item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module information in GET responses. Additional keys: not allowed |
api_name | string | Required within parent | API name of the module. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the module. Maximum length: 255 |
Retrieve a specific get record component from a Kiosk — response body — get records item criteria
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | JSON | Root | Represents the top-level filter criterion returned in the response, supporting both simple field-based filters and complex grouped filters with logical operators. |
$ (anyOf 1) | Model | Alternative | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
$ (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or |
Referenced models: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or, Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
Retrieve a specific get record component from a Kiosk — response body — get records item selection details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Selection details in GET responses. selection_type can be null for single result_type. Additional keys: not allowed |
limit | JSON | Required within parent | |
limit (anyOf 1) | integer | Alternative | Selection limit. Format: int32 |
limit (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
range | JSON | Required within parent | |
range (anyOf 1) | integer | Alternative | Fetch range. Format: int32 |
range (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
result_type | string | Required within parent | Result type: single, multiple, or all. Maximum length: 255 |
selection_type | JSON | Required within parent | |
selection_type (anyOf 1) | string | Alternative | Selection behavior type. Null for single record results. Maximum length: 255 |
selection_type (anyOf 2) | null | Alternative | Selection behavior type. Null for single record results. Maximum length: 255 |
Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Order by field information in GET responses. Additional keys: not allowed |
api_name | string | Required within parent | API name of the field. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the field. Maximum length: 255 |
Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the grouped filter criterion returned in the response, containing multiple filter conditions evaluated with a logical operator. Supports recursive nesting for complex filtering logic. Additional keys: not allowed |
$disrupted | boolean | Optional | Indicates whether the grouped filter criterion is in a disrupted state, typically due to an invalid or unresolvable condition within the group. |
group | array | Required within parent | Contains an array of filter conditions grouped together and evaluated with the specified logical operator. Maximum items: 25 Minimum items: 2 |
group[] | JSON | Each item | |
group[] (anyOf 1) | Model | Alternative | Expand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value |
group[] (anyOf 2) | Model | Alternative | Expand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or |
group_operator | string | Required within parent | Represents the logical operator applied between the filter conditions in the group. Possible values: AND - All conditions in the group must be satisfied. OR - At least one condition in the group must be satisfied. and - Equivalent to AND; all conditions in the group must be satisfied. or - Equivalent to OR; at least one condition in the group must be satisfied. Known values: AND, OR, and, or |
Referenced models: Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or, Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
Related Records — request body — query / filters / value / comparator: in, not in, type: merge field, pre defined, value, field field api name, id
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Represents the base field reference used in filter operations, containing minimal required properties. The field's data_type is not part of this object; resolve it from the corresponding FieldSchema. For formula fields, use formula.return_type as the effective data_type; for rollup_summary fields, use rollup_summary.return_type. Additional keys: allowed |
api_name | string | Optional | Represents the API name of the field used for filter application. Supports relationship notation, for example, Deals__r.Stage. |
id | string | Optional | Represents the unique ID of the field used for filter operations. Format: int64 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getallkioskgetrecords. Catalog operation: getAllKioskGetRecords. 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]