Get Specific Execution of a Kiosk
Purpose
Retrieves the details of a specific Kiosk execution, including its current state, available transitions, execution data, screen elements, and the runtime values associated with those elements.
Prerequisite:
For execution_ID, refer to Get Executions of a Kiosk if the Kiosk execution has already started.
If the execution has not started yet, refer to the Execute a Kiosk API to start a Kiosk execution.
Note
Availability: Standard, Professional, Enterprise, and Ultimate editions.
Endpoints
- GET /settings/kiosks/{kiosk_ID}/executions/{execution_ID}
- {kiosk_ID} : The unique ID of the kiosk.
- {execution_ID} : The unique ID of the execution.
Request Details
Request URL
{api-domain}/crm/{version}/settings/kiosks/{kiosk_ID}/executions/{execution_ID}
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
ZohoCRM.settings.kiosks.ALL
(or)
ZohoCRM.settings.kiosks.READ
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/kiosks/111111000000124466/executions/2296900000011330201"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxx"Response JSON
The response body is a JSON object containing a kiosk_executions array. The array contains the details of the requested state execution, with the following fields:
- executable_infoJSON object
Contains information about the current state being executed, along with the transitions that can be performed from that state.
- stateJSON object
The current state details.
- name string
The display name of the state being executed.
- id string
The unique identifier of the state being executed.
- transitionsJSON array
An array of available transitions from the current state. Each object contains prop_name, is_connected_end, name, and id fields.
- prop_name string
Represents the button's style.
Possible values:
primary - Displays the button as the primary action on the screen, typically used for actions such as Next, Submit, or Save.
default - Displays the button with the standard appearance, suitable for secondary actions.
outlineprimary - Displays the button with a primary-colored outline, emphasizing the action without making it the primary button.
failure - Displays the button with a solid error-themed style, typically used for destructive or critical actions such as Delete or Reject.
outlineredlight - Displays the button with a red outline, typically used for secondary destructive actions such as Cancel, Discard, or Remove.
- is_connected_endBoolean
Indicates whether clicking this transition leads to a end state in the Kiosk.
- name string
The display label rendered on the transition button in the Kiosk UI.
- idstring
Represents the transition ID.
- dataJSON object
Contains the runtime data available during the Kiosk execution. This object includes system-generated values (such as execution details, owner information, and record references) along with dynamically generated key-value pairs. The dynamic keys correspond to the API names of the configured Kiosk fields, GetRecords elements, and other runtime values available in the current execution. The fields returned vary depending on the Kiosk configuration and the execution context.
- id string
The unique identifier of the Kiosk execution record.
- Kiosk_Start_Time string
The timestamp when the Kiosk execution started, in ISO 8601 format.
- Kiosk_End_Time string
The timestamp indicating when the execution was last paused for ongoing Kiosks, in ISO 8601 format.
- OwnerJSON object
Specifies the information about the user who initiated this Kiosk execution.
- name string
The display name of the owner.
- id string
The unique identifier of the owner.
- email string
The email address of the owner.
- CurrentRecordJSON object
Contains information about the current record context in which the Kiosk is operating.
- id string
The unique identifier of the current record associated with this Kiosk execution.
- GetRecords_1JSON object
Contains the record reference retrieved by the Get Records element configured in the Kiosk. The key name corresponds to the API name of the get_records element and varies depending on the Kiosk configuration.
- id string
The unique identifier of the record retrieved by the Get Records element.
- Email_provided string
The value of the custom field configured in the Kiosk screen. This field captures or displays the email address provided during execution. Returns null if no value is set.
- Email string
The email field value from the current or retrieved record. Returns null if the record has no email value.
- Phone string
The phone field value from the current or retrieved record. Returns null if the record has no phone value.
- Phone_Number string
The value of the custom phone number field configured in the Kiosk screen. Returns null if no value is set.
- Pick_List string
The value of the picklist field configured in the Kiosk screen. Returns null if no selection has been made.
- Pick_List_Field string
An additional picklist field value from the Kiosk configuration or current record. Returns null if no value is set.
- elementsJSON array
An array of UI elements and data sources configured in the Kiosk. Each element has a type field that determines its structure.
- get_recordJSON object
Contains the record retrieval configuration and data.
- selection_detailsJSON object
Configuration for record selection. Contains the following fields.
- selection_type string
Specifies how the records are chosen for retrieval (e.g., by user selection, criteria-based filter, or a specific record ID). Returns null when no explicit selection method is configured.
- result_type string
Specifies whether the get_record element returns a single record or multiple records from the selected module.
- limitinteger
The maximum number of records to retrieve.
- rangeinteger
The starting range for record retrieval.
- open_recordBoolean
Specifies whether clicking the record opens the detail view.
- name string
The display name of the GetRecords element.
- id string
The unique identifier of the GetRecords element.
- moduleobject
Specifies the module from which records are retrieved. Contains api_name and id of the module.
- selected_fieldsJSON array
Array of fields to be displayed for each retrieved record. It contains api_name and id of each field.
- typestring
Specifies the type of UI element represented by the object.
- valueJSON array
Array of retrieved records with their field values.
- get_record_dataJSON object
Additional data associated with the get_records operation.
- more_recordsBoolean
Indicates whether there are more records beyond the current result set.
- fieldJSON object
Displays a form field for user input. Contains type , field object with: field_label, api_name, data_type, ui_type, read_only, required, length, id, and pick_list_values for picklist fields, and value containing the field value.
- width string
The width of the kiosk display.
Possible values: 670px, 1000px
- title string
The title of the current screen.
- id string
Specifies the execution ID.
- button_align string
The alignment of action buttons.
Possible values:
right_to_left - Buttons are aligned from right to left.
left_to_right - Buttons are aligned from left to right.
center - Buttons are aligned to the center.
Possible Errors
- INVALID_DATA HTTP 400
No such Kiosk exists.
Resolution: Specify a valid Kiosk ID in the request URL. - OAUTH_SCOPE_MISMATCHHTTP 401Invalid oauth scope to access this URL.
Resolution: Create a new token with the required scopes. Refer to the scope section. - AUTHENTICATION_FAILUREHTTP 401Authentication Failed.
Resolution: Pass the access token in the request header of the API call. - INVALID_URL_PATTERN HTTP 404
Please check if the URL trying to access is a correct one.
Resolution: Specify valid URL in the request. Refer to the Endpoints section.
Sample Response
Copied{
"kiosk_executions": [
{
"executable_info": {
"state": {
"name": "Screen 4",
"id": "5039614000000890166"
},
"transitions": [
{
"prop_name": "primary",
"is_connected_end": false,
"name": "Done",
"id": "5039614000000890164"
}
]
},
"data": {
"Kiosk_End_Time": "2026-04-21T14:47:56+05:30",
"Pick_List": null,
"Owner": {
"name": "Patricia Boyle",
"id": "5039614000000709001",
"email": "patricia.boyle@test.com"
},
"Email": null,
"Pick_List_Field": null,
"Email_provided": "patricia.boyle@test.com",
"Phone": null,
"Phone_Number": null,
"id": "5039614000000938041",
"CurrentRecord": {
"id": "5039614000000782064"
},
"Kiosk_Start_Time": "2026-04-21T14:47:56+05:30",
"GetRecords_1": {
"id": "5039614000000782064"
}
},
"elements": [
{
"type": "text",
"value": "Hi Acme !!"
},
{
"get_record": {
"selection_details": {
"selection_type": null,
"result_type": "single",
"limit": 1,
"range": 1
},
"open_record": true,
"module": {
"api_name": "Leads",
"id": "5039614000000000125"
},
"name": "GetRecords 1",
"id": "5039614000000869480",
"selected_fields": [
{
"api_name": "id",
"id": "5039614000000337001"
},
{
"api_name": "Owner",
"id": "5039614000000000553"
},
{
"api_name": "First_Name",
"id": "5039614000000000557"
},
{
"api_name": "Last_Name",
"id": "5039614000000000559"
},
{
"api_name": "Designation",
"id": "5039614000000000561"
},
{
"api_name": "Email",
"id": "5039614000000000563"
},
{
"api_name": "Phone",
"id": "5039614000000000565"
},
{
"api_name": "Lead_Source",
"id": "5039614000000000573"
},
{
"api_name": "Lead_Status",
"id": "5039614000000000575"
}
]
},
"type": "get_records",
"value": [
{
"First_Name": "Acme",
"Lead_Status": "Not Contacted",
"Designation": null,
"Owner": {
"name": "Patricia Boyle",
"id": "5039614000000869577"
},
"Email": "sarah.acme@test.com",
"Last_Name": "Sarah",
"Phone": null,
"Lead_Source": null,
"id": "5039614000000782064"
}
],
"get_record_data": null,
"more_records": false
},
{
"field": {
"allow_multiple_upload": null,
"field_label": "Email",
"length": 255,
"tooltip": null,
"_merge_field": "${Users.5039614000000000189}",
"number_separator": false,
"required": false,
"ui_type": 1,
"read_only": false,
"api_name": "Email",
"data_type": "text",
"currency": null,
"id": "5039614000000890101",
"_pick_list_type": null,
"decimal_place": null,
"pick_list_values": null
},
"type": "field",
"value": "patricia.boyle@test.com"
},
{
"field": {
"allow_multiple_upload": null,
"field_label": "Phone",
"length": 30,
"tooltip": null,
"_merge_field": "${ProcessFlow1.5039614000000869451.5039614000000000565}",
"number_separator": false,
"required": false,
"ui_type": 33,
"read_only": false,
"api_name": "Phone",
"data_type": "phone",
"currency": null,
"id": "5039614000000890112",
"_pick_list_type": null,
"decimal_place": null,
"pick_list_values": null
},
"type": "field",
"value": null
},
{
"field": {
"allow_multiple_upload": null,
"field_label": "Pick List",
"length": 500,
"tooltip": null,
"_global_picklist_name": {
"display_label": "Industry",
"api_name": "Industry"
},
"_merge_field": "${ProcessFlow1.5039614000000869451.5039614000000000577}",
"number_separator": false,
"required": false,
"global_picklist": {
"api_name": "Industry",
"id": "5039614000000491020"
},
"ui_type": 2,
"read_only": false,
"api_name": "Pick_List",
"data_type": "picklist",
"currency": null,
"_pick_list_type": "global_set",
"id": "5039614000000890123",
"decimal_place": null,
"pick_list_values": [
{
"display_value": "-None-",
"sequence_number": 1,
"actual_value": "-None-",
"id": "5039614000000890128"
},
{
"display_value": "ASP (Application Service Provider)",
"sequence_number": 2,
"actual_value": "ASP (Application Service Provider)",
"id": "5039614000000890130"
},
{
"display_value": "Data/Telecom OEM",
"sequence_number": 3,
"actual_value": "Data/Telecom OEM",
"id": "5039614000000890132"
},
{
"display_value": "ERP (Enterprise Resource Planning)",
"sequence_number": 4,
"actual_value": "ERP (Enterprise Resource Planning)",
"id": "5039614000000890134"
},
{
"display_value": "Government/Military",
"sequence_number": 5,
"actual_value": "Government/Military",
"id": "5039614000000890136"
},
{
"display_value": "Large Enterprise",
"sequence_number": 6,
"actual_value": "Large Enterprise",
"id": "5039614000000890138"
},
{
"display_value": "ManagementISV",
"sequence_number": 7,
"actual_value": "ManagementISV",
"id": "5039614000000890140"
},
{
"display_value": "MSP (Management Service Provider)",
"sequence_number": 8,
"actual_value": "MSP (Management Service Provider)",
"id": "5039614000000890142"
},
{
"display_value": "Network Equipment Enterprise",
"sequence_number": 9,
"actual_value": "Network Equipment (Enterprise)",
"id": "5039614000000890144"
},
{
"display_value": "Non-management ISV",
"sequence_number": 10,
"actual_value": "Non-management ISV",
"id": "5039614000000890146"
},
{
"display_value": "Optical Networking",
"sequence_number": 11,
"actual_value": "Optical Networking",
"id": "5039614000000890148"
},
{
"display_value": "Service Provider",
"sequence_number": 12,
"actual_value": "Service Provider",
"id": "5039614000000890150"
},
{
"display_value": "Small/Medium Enterprise",
"sequence_number": 13,
"actual_value": "Small/Medium Enterprise",
"id": "5039614000000890152"
},
{
"display_value": "Storage Equipment",
"sequence_number": 14,
"actual_value": "Storage Equipment",
"id": "5039614000000890154"
},
{
"display_value": "Storage Service Provider",
"sequence_number": 15,
"actual_value": "Storage Service Provider",
"id": "5039614000000890156"
},
{
"display_value": "Systems Integrator",
"sequence_number": 16,
"actual_value": "Systems Integrator",
"id": "5039614000000890158"
},
{
"display_value": "Wireless Industry",
"sequence_number": 17,
"actual_value": "Wireless Industry",
"id": "5039614000000890160"
}
]
},
"type": "field",
"value": null
}
],
"width": "670px",
"id": "5039614000000938041",
"title": "Screen 4",
"button_align": "right_to_left"
}
]
}