Kiosk GetRecords

This API allows you to retrieve GetRecords configurations associated with a Kiosk. You can either fetch all configurations or retrieve a specific GetRecords element using its ID. The response includes details such as criteria, selection configuration, selected fields, module information, and sorting preferences.

Purpose

To retrieve all or a specific GetRecords configuration for a given Kiosk.

Use the Get All Kiosks API to retrieve the Kiosk ID.

Note
Availability: Standard, Professional, Enterprise, and Ultimate editions.

Permission Required: Administrator profile, or profiles with either the Module Customization or Manage Automation permission enabled.

Endpoints

GET /settings/kiosks/{kiosk_ID}/get_records
GET /settings/kiosks/{kiosk_ID}/get_records/{getrecord_ID}

Request Details

Request URL

To get All GetRecords:
{api-domain}/crm/{version}/settings/kiosks/{kiosk_ID}/get_records
To get a Specific GetRecord:
{api-domain}/crm/{version}/settings/kiosks/{kiosk_ID}/get_records/{getrecord_ID}

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

ZohoCRM.settings.kiosks.READ
(or)
ZohoCRM.settings.ALL

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/kiosks/5725767000010015021/get_records"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

The get_records JSON array contains all the GetRecords configurations defined for the specified Kiosk.

namestring
Represents the name of the GetRecords configuration.
idstring
Represents the unique ID of the GetRecords element.
typestring
Represents the type of the GetRecords configuration. The value depends on how the GetRecords configuration is defined in the Kiosk.
Possible values: parent, child.
selection_detailsJSON object
Represents the record selection behavior configured for the GetRecords configuration, including whether users can select records, whether a single or multiple records are displayed, and the maximum number of records that can be displayed.
- selection_typestring
  Represents how users can interact with the records displayed by the GetRecords configuration during Kiosk execution.
  Possible values:
  mandatory: User must select at least one record.
  optional: User may choose records, but selection is not mandatory.
  read_only: Records are only displwayed and cannot be selected.
- result_typestring
  Represents the number of records returned by the GetRecords configuration during Kiosk execution.
  Possible values:
  single - Returns a single record.
  multiple - Returns multiple records.
  all - Returns all matching records.
- limitinteger
  Represents the maximum number of records to retrieve.
- rangeinteger
  Represents the maximum number of records that can be listed during Kiosk execution.
criteriaJSON object
Represents the filter conditions used to fetch records.
- comparatorstring
  Represents the comparison operator used for filtering. For example, equals and contains.
- fieldJSON object
  Represents the details of the field used in the criteria.
  - api_namestring
    Represents the API name of the field.
  - idstring
    Represents the unique ID of the field.
- typestring
  Represents the type of criteria used to evaluate the specified field.
  Possible values: value
- valuestring
  Represents the value against which the specified field value of each record is compared when evaluating the criteria.
moduleJSON object
Represents the module from which records are retrieved.
- api_namestring
  Represents the API name of the module.
- idstring
  Represents the unique ID of the module.
selected_fieldsJSON array
Represents the list of fields selected for retrieval. Returns null if no specific fields are defined.
sort_orderJSON object
Represents how the fetched records are sorted.
- order_by_namestring
  Represents the sorting order. For example, ascending and descending.
- order_by_fieldJSON object
  Represents the field used for sorting the records.
  - api_namestring
    Represents the API name of the field.
  - idstring
    Represents the unique ID of the field.

Note

The response structure is dynamic and depends on the GetRecords configuration. Fields such as criteria, type, and selection_details may vary based on the configured settings.

Possible Errors

INVALID_DATAHTTP 400
- Invalid Kiosk ID
  Resolution: Specify a valid Kiosk ID. Use the Get All Kiosks API to retrieve the Kiosk ID.
- Invalid GetRecord ID
  Resolution: Specify a valid GetRecord ID. Use the Kiosk GetRecord API to know the valid ID.
INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to the Endpoints section for more details.
OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: The client does not have a valid scope to retrieve all or a specific Kiosk GetRecords details. Create a new token with valid scope. Refer to the Scope section for more details.
AUTHENTICATION_FAILUREHTTP 401
Authentication failed
Resolution: Pass the access token in the request header of the API call.
NO_PERMISSIONHTTP 403
Permission denied
Resolution: Contact your system administrator.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to the Request URL section for more details.
INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in the server. Contact support team.

Sample Response

Copied{
    "get_records": [
        {
            "selection_details": {
                "selection_type": "read_only",
                "result_type": "multiple",
                "limit": 100,
                "range": 100
            },
            "criteria": {
                "comparator": "contains",
                "field": {
                    "api_name": "Email",
                    "id": "5725767000000002599"
                },
                "type": "value",
                "value": "patricia@mail.com"
            },
            "module": {
                "api_name": "Leads",
                "id": "5725767000000002175"
            },
            "name": "Get Lead records",
            "id": "5725767000010016117",
            "type": "parent",
            "sort_order": {
                "order_by_name": "descending",
                "order_by_field": {
                    "api_name": "Modified_Time",
                    "id": "5725767000000002629"
                }
            }
        }
    ]
}