Get Executions of a Kiosk

Purpose

Retrieves executions of a specific Kiosk which are not completed. For each execution, the response includes the user who executed the Kiosk, the execution start and end times, the current or most recently executed state, and the transition that can be executed next. Multiple executions of the same Kiosk, such as those initiated by different users, are also returned.

Prerequisite: To obtain the Kiosk ID required for this request, use the Get Kiosks API.

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

Endpoints

GET /settings/kiosks/{kiosk_ID}/executions

{kiosk_ID} : The unique ID of the kiosk.

Request Details

Request URL

{api-domain}/crm/{version}/settings/kiosks/{kiosk_ID}/executions

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Scope

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

Note

The Kiosk must be in published status and have at least one active execution to retrieve execution details.

Sample Request

Copiedcurl "https://www.zohoapis.com/crm/v8/settings/kiosks/111111000000124466/executions"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.xxxxxxxxxxxxx"

Response JSON

The response body is a JSON object containing a kiosk_executions array and an info object. Each object in the kiosk_executions array contains the following fields:

kiosk_executionsJSON array
Contains a collection of kiosk execution records for the specified Kiosk.
- Kiosk_End_Time string
  The timestamp indicating when the most recently executed state of the Kiosk ended, in ISO 8601 format. The response is sorted in descending order of this field, with the most recent executions listed first.
- OwnerJSON object
  Contains information about the owner of the record who initiated this kiosk execution.
  - name string
    The display name of the owner.
  - id string
    The unique identifier of the owner.
- executable_infoJSON object
  Contains information about the current state of the Kiosk execution and the transition that can be executed next.
  - stateJSON object
    The current state details of the kiosk execution.
    - name string
      The display name of the current state (for example, "Screen 2").
    - id string
      The unique identifier of the current state.
  - transitionsJSON array
    An array of available next transitions from the current state. Each transition object contains the unique identifier of an available transition from the current state.
    - id string
      The unique identifier of the available transition.
- id string
  The unique identifier of this kiosk execution record.
- Kiosk_Start_Time string
  The timestamp when the kiosk execution started, in ISO 8601 format.
infoJSON object
Contains pagination metadata for the response.
- per_pageInteger
  The number of execution records returned per page.
- countInteger
  The total number of execution records in the current response.
- pageInteger
  The current page number.
- more_recordsBoolean
  Indicates whether there are more execution records available beyond the current page.

Note
A Kiosk execution is marked as complete only when the user navigates through all screens and closes the Kiosk on the final screen. Completed executions will not appear in the GET API response.

If the Kiosk is closed prematurely or terminated forcefully before reaching the final screen, the execution remains in an active state. Active executions will continue to appear in the GET executions response.

Possible Errors

NOCONTENT HTTP 204
No active Kiosk executions.
Resolution: Publish the Kiosk if it is not already published, and ensure that it has at least one active execution before making the request. Refer here for more details.
INVALID_DATA HTTP 400
No such Kiosk exists.
Resolution: Verify that the kiosk_ID in the request URL is a valid and existing Kiosk identifier. You can retrieve a list of valid Kiosk IDs using the GET Kiosks API.
OAUTH_SCOPE_MISMATCHHTTP 401
Invalid oauth scope to access this URL.
Resolution: Create a new token with the required scopes. Refer to the scope section.
AUTHENTICATION_FAILUREHTTP 401
Authentication Failed.
Resolution: Pass the access token in the request header of the API call.
INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one.
Resolution: Refer Request Section for URL details.

Sample Response

Copied{
    "kiosk_executions": [
        {
            "Kiosk_End_Time": "2026-07-20T14:00:35+05:30",
            "Owner": {
                "name": "Patricia Boyle",
                "id": "5039614000000709001"
            },
            "executable_info": {
                "state": {
                    "name": "Screen 3",
                    "id": "5039614000001093340"
                },
                "transitions": [
                    {
                        "id": "5039614000001093344"
                    }
                ]
            },
            "id": "5039614000001217171",
            "Kiosk_Start_Time": "2026-07-20T14:00:31+05:30"
        },
        {
            "Kiosk_End_Time": "2026-07-20T14:00:14+05:30",
            "Owner": {
                "name": "Patricia Boyle",
                "id": "5039614000000709001"
            },
            "executable_info": {
                "state": {
                    "name": "Screen 2",
                    "id": "5039614000001093341"
                },
                "transitions": [
                    {
                        "id": "5039614000001093347"
                    }
                ]
            },
            "id": "5039614000001217169",
            "Kiosk_Start_Time": "2026-07-20T14:00:13+05:30"
        },
        {
            "Kiosk_End_Time": "2026-07-20T13:10:45+05:30",
            "Owner": {
                "name": "Test Acme",
                "id": "5039614000001006037"
            },
            "executable_info": {
                "state": {
                    "name": "Screen 2",
                    "id": "5039614000001093341"
                },
                "transitions": [
                    {
                        "id": "5039614000001093347"
                    }
                ]
            },
            "id": "5039614000001217114",
            "Kiosk_Start_Time": "2026-07-20T13:10:44+05:30"
        }
    ],
    "info": {
        "per_page": 80,
        "count": 3,
        "page": 1,
        "more_records": false
    }
}