# Retrieve the full configuration details of a Kiosk payload item

Get Android Kiosk payload

## Endpoints

**GET** `/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id}`

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id}
```

## Scope

```
MDMOnDemand.MDMDeviceMgmt.READ
```

## Header

```
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Path Parameters

- **profile_id** (string) — Mandatory  
  Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-get-profile.html) response.

- **payload_id** (string) — Mandatory  
  Unique identifier of the payload item. Obtain from the [Get Payload Item IDs](https://www.manageengine.com/mobile-device-management/help/api/cloud/android-get-kiosk-payload.html) response.

### Query Parameters

- **include** (string) — Optional  
  Comma-separated list of related fields to include in the response (e.g., assigned_to, payload_details). When omitted, only top-level fields are returned.

## Sample Request

### Curl

```bash
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

### Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id}"))
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());

  }
}
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("appdomain")

headers = { 'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52" }

conn.request("GET", "/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

### Deluge

```javascript
headersMap = Map();
headersMap.put("Accept", "application/json");

response = invokeUrl
[
    url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id}"
    type: GET
    headers: headersMap
    connection: connection_name
]

info response;
```

### PowerShell

```powershell
$headers=@{}
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskpolicy/payloaditems/{payload_id}' -Method GET -Headers $headers
```

## Response Parameters

### HTTP 200

**Response Body**: `application/json`  
Returns a JSON object.

- **payload_id** (long)  
  Unique identifier of the payload item.

- **sub_config** (string)  
  Sub-configuration type identifier.

- **kiosk_mode** (integer)  
  Kiosk mode.  
  - `0` = Single App  
  - `1` = Multi App  
  - `3` = Single Web App (COSU)  
  Default: `0`

- **launcher_type** (integer)  
  Launcher type.  
  - `1` = Default device launcher  
  - `2` = ME MDM custom launcher  
  Default: `2`

- **allowed_apps** (array of objects)  
  List of apps allowed in kiosk mode.  
  Each object contains:
  - **group_display_name** (string) — Display name of the app or app group  
  - **app_id** (long) — Unique identifier of the app group

- **background_apps** (array of objects)  
  List of apps that run in the background during kiosk mode.  
  Each object contains:
  - **group_display_name** (string) — Display name of the app or app group  
  - **app_id** (long) — Unique identifier of the app group

- **enable_default_app** (boolean)  
  Whether a default app is launched automatically in kiosk mode. Default: `false`

- **default_kiosk_app** (array of objects)  
  The default app launched automatically when kiosk mode starts (single app).  
  Each object contains:
  - **group_display_name** (string) — Display name of the app or app group  
  - **app_id** (long) — Unique identifier of the app group

- **default_app_launch_mode** (integer)  
  Default app launch behavior. Default: `0`

- **default_app_launch_timeout** (integer)  
  Seconds of idle time before the default app is relaunched. Default: `20`

- **wallpaper** (long)  
  Wallpaper image file ID.

- **is_wallpaper_removed** (boolean)  
  Whether the kiosk wallpaper image has been removed. Default: `false`

- **show_me_mdm_app** (boolean)  
  Whether the ME MDM app is visible on the kiosk launcher. Default: `true`

- **allow_notification_badge** (boolean)  
  Whether notification badges are shown on app icons in kiosk mode. Default: `false`

- **allow_task_manager** (boolean)  
  Whether the task manager is accessible in kiosk mode. Default: `true`

- **allow_system_bar** (boolean)  
  Whether the system bar is visible in kiosk mode. Default: `true`

- **allow_navigation_bar** (boolean)  
  Whether the navigation bar is visible in kiosk mode. Default: `true`

- **allow_status_bar** (boolean)  
  Whether the status bar is visible in kiosk mode. Default: `true`

- **allow_status_bar_expansion** (boolean)  
  Whether the status bar can be expanded in kiosk mode. Default: `true`

- **allow_home_button** (boolean)  
  Whether the home button is functional in kiosk mode. Default: `true`

- **allow_power_button** (boolean)  
  Whether the power button is functional in kiosk mode. Default: `true`

- **allow_back_button** (boolean)  
  Whether the back button is functional in kiosk mode. Default: `true`

- **allow_shutdown** (boolean)  
  Whether the device can be shut down in kiosk mode. Default: `true`

- **allow_key_guard** (boolean)  
  Whether the key guard (lock screen) is enabled in kiosk mode. Default: `true`

- **allow_notification** (boolean)  
  Whether notifications are shown in kiosk mode. Default: `true`

- **allow_system_error_dialog** (boolean)  
  Whether app crash dialogs are displayed in kiosk mode. Default: `false`

- **allow_recent_apps** (boolean)  
  Whether the recent apps view is accessible in kiosk mode. Default: `true`

- **allow_custom_settings** (boolean)  
  Whether the custom settings app is enabled in kiosk mode. Default: `true`

- **is_stay_awake_on_charging** (boolean)  
  Whether the device stays awake while charging in kiosk mode. Default: `true`

- **allow_simunlock** (boolean)  
  Whether SIM unlock is allowed in kiosk mode. Default: `true`

- **allow_multiwindow** (boolean)  
  Whether multi-window (split screen) mode is allowed in kiosk mode. Default: `true`

- **kiosk_custom_settings** (object)  
  Advanced kiosk device feature controls configuration:
  - **allow_wifi** (boolean) — Whether the user can access Wi-Fi settings. Default: `true`
  - **screen_orientation** (string) — Values: `PORTRAIT`, `LANDSCAPE`, `AUTO`
  - **allow_brightness** (boolean) — Default: `true`
  - **screen_timeout** (string) — Timeout in milliseconds.  
    `0` = User controlled  
    `15000` = 15 sec  
    `30000` = 30 sec  
    `60000` = 1 min  
    `300000` = 5 min  
    `1800000` = 30 min  
    `2147483647` = Always on
  - **allow_flash_light** (boolean) — Default: `true`
  - **allow_mobile_network** (boolean) — Default: `true`
  - **allow_mobile_hotspot_settings** (boolean) — Default: `true`
  - **hotspot_settings_timeout** (integer) — Default: `30`
  - **allow_bluetooth_settings** (boolean) — Default: `true`
  - **bluetooth_settings_timeout** (integer) — Default: `30`
  - **allow_apn_settings** (boolean) — Default: `true`
  - **apn_settings_timeout** (integer) — Default: `30`
  - **settings_timeout** (integer) — Default: `30`
  - **allow_wifi_network_configuration** (boolean) — Default: `true`
  - **allow_battery_optimization** (boolean) — Default: `true`
  - **allow_locale_settings** (boolean) — Default: `true`
  - **allow_device_passcode_change_settings** (boolean) — Default: `true`
  - **allow_display_settings** (boolean) — Default: `true`
  - **battery_optimized_apps** (array of objects)  
    - **group_display_name** (string)  
    - **app_id** (long)
  - **mobile_data_usage** (boolean) — Default: `true`
  - **default_keyboard** (boolean) — Default: `true`
  - **allow_location_settings** (boolean) — Default: `true`
  - **allow_airplane_mode** (boolean) — Default: `true`
  - **allow_location** (boolean) — Default: `true`
  - **allow_nfc_settings** (boolean) — Default: `true`
  - **allow_datetime_settings** (boolean) — Default: `true`
  - **allow_accessibility_settings** (boolean) — Default: `true`

- **auto_distribute_apps** (boolean)  
  Whether kiosk apps are automatically distributed to the device. Default: `true`

- **webclippolicies** (array of objects)  
  List of web shortcuts displayed on the kiosk home screen.  
  Each object contains:
  - **webclip_policy_id** (long) — Unique identifier of the web shortcut policy  
  - **webclip_name** (string) — Display name of the web shortcut

- **auto_distribute_webapp** (boolean)  
  Whether kiosk web shortcuts are automatically distributed. Default: `true`

- **exit_kiosk_password** (string)  
  Password required to exit kiosk mode (write-only; use `exit_kiosk_password_id` for credential ID reads).

- **exit_kiosk_password_id** (long)  
  ID of the saved password credential for kiosk exit.

- **idle_refresh_timeout** (integer)  
  Seconds of idle time before web shortcuts are refreshed. `-1` = Disabled. Default: `-1`

- **clear_cookies_on_idle_timeout** (boolean)  
  Whether cookies are cleared when the idle refresh timeout triggers. Default: `true`

- **clear_cache_on_idle_timeout** (boolean)  
  Whether cache is cleared when the idle refresh timeout triggers. Default: `false`

## Sample Response (HTTP 200)

```json
{
  "enable_default_app": false,
  "payload_id": 9007199254741000,
  "launcher_type": 2,
  "default_kiosk_app": [],
  "wallpaper": "value",
  "sub_config": "KIOSK_CUSTOM_SETTINGS",
  "default_app_launch_timeout": 20,
  "allowed_apps": [],
  "default_app_launch_mode": 0,
  "kiosk_mode": 0,
  "background_apps": []
}
```

## Possible Response Codes

- **200** — Successful request

## Rate Limiting

**Duration:** 1 minute  
**Threshold:** 120  
**Lock period:** 5 minutes  

- **Duration** — Time window for the threshold.  
- **Threshold** — Number of API calls allowed within the specified duration.  
- **Lock period** — Wait time before consecutive API requests.