Get a Specific Kiosk

Purpose

To retrieve the details and configuration of a specific Kiosk in Zoho CRM using its unique ID. 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}

Request Details

Request URL

{api-domain}/crm/{version}/settings/kiosks/{kiosk_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/5725767000009995093"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"

Response JSON

The kiosks JSON array represents the list of Kiosk records returned in the response.

created_timestring
Represents the date and time at which the Kiosk was created, in ISO 8601 format.
chart_dataJSON object
Represents the structure of the Kiosk by defining how its states and transitions are connected.
- nodesJSON array
  Represents the list of state references in the Kiosk structure.
  - idJSON string
    Represents the unique ID of a node in the Kiosk structure.
    Note: The number of nodes returned depends on the states configured in the Kiosk. The response always includes the Start and End states.
    Possible limits:
    - Enterprise and above: 150
    - Professional: 50
    - Standard: 25
- connectionsJSON array
  Represents the connections between states in the Kiosk.
  - fromJSON object
    Represents the source state of the connection.
    - idstring
      Represents the unique ID of the source state.
  - toJSON object
    Represents the destination state of the connection.
    - idstring
      Represents the unique ID of the destination state.
  - transitionJSON object
    Represents the transition associated with the connection between two states.
    - idstring
      Represents the unique ID of the transition.
version_detailsJSON object
Represents the version information of the Kiosk.
- parent_idstring
  Represents the unique ID of the parent version from which the current Kiosk version was derived.
- version_numberinteger
  Represents the version number of the Kiosk.
moduleJSON object
Represents the module in which the Kiosk is created.
- api_namestring
  Represents the API name of the module.
- idstring
  Represents the unique ID of the module.
descriptionstring
Represents the description of the Kiosk.
transitionsJSON array
Represents the list of transitions configured in the Kiosk.
- namestring
  Represents the name of the transition.
- idstring
  Represents the unique identifier of the transition.
created_byJSON object
Represents the details of the user who created the Kiosk.
- namestring
  Represents the name of the user.
- idstring
  Represents the unique ID of the user.
statesJSON array
Represents the list of states configured in the Kiosk, such as screen, decision, action, and getrecord.
- namestring
  Represents the name of the state.
- idstring
  Represents a unique identifier of the state.
- typestring
  Represents the type of the state.
  Possible values:
  start_state - Represents the entry point of the Kiosk.
  end_state - Represents the exit point of the Kiosk.
  screen - Represents a screen displayed to the user.
  decision - Represents a decision point that evaluates configured criteria and determines the next state.
  action - Represents an action performed within the Kiosk.
  getrecord - Represents a state that retrieves records from Zoho CRM.
  The state types returned depend on your Kiosk configuration.
sequence_numberinteger
Represents the order in which the Kiosk is displayed relative to other Kiosks in the UI.
modified_timestring
Represents the date and time when the Kiosk was last modified.
group_idstring
Represents the unique identifier of the Kiosk group. All versions such as draft, active, and inactive of the same Kiosk share the same group_id.
current_record_moduleJSON object
Represents the module configured as the Kiosk's Current Record context. All operations that use the Current Record, such as field references, criteria evaluation, GetRecords, and actions, are performed on records from this module.
- plural_labelstring
  Represents the display label of the module.
- api_namestring
  Represents the API name of the module.
- idstring
  Represents the unique ID of the module.
associatedBoolean
Represents whether the Kiosk is associated with a supported location, such as the Record Details View or other supported locations. It does not represent cross-module associations.
Possible values:
true - Represents that the Kiosk is associated with one or more supported locations.
false - Represents that the Kiosk is not associated with any supported locations.
namestring
Represents the name of the Kiosk.
modified_byJSON object
Represents the details of the user who last modified the Kiosk.
- namestring
  Represents the name of the user who modified the Kiosk.
- idstring
  Represents the unique ID of the user who modified the Kiosk.
idstring
Represents the unique identifier of the Kiosk.
statusstring
Represents the current status of the Kiosk.
Possible values: draft, active, inactive.
group_api_namestring
Specifies a unique API name that is shared across all versions of the Kiosk (draft and published) to maintain a consistent API name.

Possible Errors

NO_CONTENTHTTP 204
No Kiosk has been found
Resolution: Specify a valid Kiosk ID. Get your Kiosk ID using Get all Kiosks API.
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 a specific Kiosk. 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.
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{
    "kiosks": [
        {
            "created_time": "2026-04-07T01:00:49-07:00",
            "chart_data": {
                "nodes": [
                    {
                        "id": "5725767000009999159"
                    },
                    {
                        "id": "5725767000009999160"
                    }
                ],
                "connections": [
                    {
                        "from": {
                            "id": "5725767000009999159"
                        },
                        "to": {
                            "id": "5725767000009999160"
                        },
                        "transition": {
                            "id": "5725767000009999161"
                        }
                    }
                ]
            },
            "version_details": {
                "parent_id": null,
                "version_number": 1
            },
            "module": {
                "api_name": "Kiosk",
                "id": "5725767000009995093"
            },
            "description": "To create a simple Kiosk in the Zoho CRM.",
            "transitions": [
                {
                    "name": "Start",
                    "id": "5725767000009999161"
                }
            ],
            "created_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "states": [
                {
                    "name": "End",
                    "id": "5725767000009999160",
                    "type": "end_state"
                },
                {
                    "name": "Start",
                    "id": "5725767000009999159",
                    "type": "start_state"
                }
            ],
            "sequence_number": 1,
            "modified_time": "2026-04-07T01:00:49-07:00",
            "group_id": "5725767000009999158",
            "current_record_module": null,
            "associated": false,
            "name": "Kiosk",
            "modified_by": {
                "name": "Patricia Boyle",
                "id": "5725767000000411001"
            },
            "id": "5725767000009995093",
            "status": "draft",
            "group_api_name": "Kiosk"
        }
    ]
}