Skip to content

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.

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 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_records.get_all_kiosk_get_records(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.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
$JSONRoot
$ (anyOf 1)ModelAlternativeExpand Retrieve a specific get record component from a Kiosk — response body
$ (anyOf 2)nullAlternative

Referenced models: Retrieve a specific get record component from a Kiosk — response body

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

Retrieve a specific get record component from a Kiosk — response body
FieldTypePresenceDescription and constraints
$objectRootResponse containing all get_record components with their full configuration.
Additional keys: not allowed
get_recordsarrayRequired within parentArray of get_record component details.
Maximum items: 25
get_records[]ModelEach itemExpand 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
FieldTypePresenceDescription and constraints
$objectRootComplete get_record component data as returned in GET responses.
Additional keys: not allowed
criteriaModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria
Filter criteria configured for this get_record.
idstringRequired within parentUnique identifier of the get_record component.
Maximum length: 19
moduleModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item module
namestringRequired within parentName of the get_record component.
Maximum length: 255
selected_fieldsJSONRequired within parent
selected_fields (anyOf 1)arrayAlternativeFields configured for display. Null if not configured.
Maximum items: 50
selected_fields (anyOf 1)[]stringEach itemAPI name of a selected field.
Maximum length: 30
selected_fields (anyOf 2)nullAlternativeFields configured for display. Null if not configured.
Maximum items: 50
selected_fields (anyOf 2)[]stringEach itemAPI name of a selected field.
Maximum length: 30
selection_detailsModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item selection details
sort_orderModelRequired within parentExpand Retrieve a specific get record component from a Kiosk — response body — get records item sort order
typestringRequired within parentModule 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
FieldTypePresenceDescription and constraints
$objectRootSort 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_fieldModelOptionalExpand Retrieve a specific get record component from a Kiosk — response body — get records item sort order order by field
order_by_namestringRequired within parentSort direction.
Maximum length: 255
$ (allOf 1)JSONAll 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
FieldTypePresenceDescription and constraints
$objectRootModule information in GET responses.
Additional keys: not allowed
api_namestringRequired within parentAPI name of the module.
Maximum length: 255
idstringRequired within parentUnique identifier of the module.
Maximum length: 255
Retrieve a specific get record component from a Kiosk — response body — get records item criteria
FieldTypePresenceDescription and constraints
$JSONRootRepresents the top-level filter criterion returned in the response, supporting both simple field-based filters and complex grouped filters with logical operators.
$ (anyOf 1)ModelAlternativeExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
$ (anyOf 2)ModelAlternativeExpand 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
FieldTypePresenceDescription and constraints
$objectRootSelection details in GET responses. selection_type can be null for single result_type.
Additional keys: not allowed
limitJSONRequired within parent
limit (anyOf 1)integerAlternativeSelection limit.
Format: int32
limit (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
rangeJSONRequired within parent
range (anyOf 1)integerAlternativeFetch range.
Format: int32
range (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_typestringRequired within parentResult type: single, multiple, or all.
Maximum length: 255
selection_typeJSONRequired within parent
selection_type (anyOf 1)stringAlternativeSelection behavior type. Null for single record results.
Maximum length: 255
selection_type (anyOf 2)nullAlternativeSelection 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
FieldTypePresenceDescription and constraints
$objectRootOrder by field information in GET responses.
Additional keys: not allowed
api_namestringRequired within parentAPI name of the field.
Maximum length: 255
idstringRequired within parentUnique 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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
$disruptedbooleanOptionalIndicates whether the grouped filter criterion is in a disrupted state, typically due to an invalid or unresolvable condition within the group.
grouparrayRequired within parentContains an array of filter conditions grouped together and evaluated with the specified logical operator.
Maximum items: 25
Minimum items: 2
group[]JSONEach item
group[] (anyOf 1)ModelAlternativeExpand Retrieve a specific get record component from a Kiosk — response body — get records item criteria value
group[] (anyOf 2)ModelAlternativeExpand Retrieve a specific get_record component from a Kiosk — response body — get_records / item / criteria / group_operator: AND, OR, and, or
group_operatorstringRequired within parentRepresents 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
FieldTypePresenceDescription and constraints
$objectRootRepresents 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_namestringOptionalRepresents the API name of the field used for filter application. Supports relationship notation, for example, Deals__r.Stage.
idstringOptionalRepresents the unique ID of the field used for filter operations.
Format: int64

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]

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.