Retrieve the full configuration details of a Kiosk Homescreen payload item

Get Android Kiosk payload with Home screen layout

Endpoints

get /api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy/payloaditems/{payload_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

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/androidkioskhomescreenpolicy/payloaditems/{payload_id}"))
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

headers = {
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

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

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

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


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

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

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy/payloaditems/{payload_id}' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

sub_configstring

Sub-configuration type identifier

kiosk_modeinteger

Kiosk mode. 0 = Single App, 1 = Multi App, 3 = Single Web App (COSU). Default: 0

launcher_typeinteger

Launcher type. 1 = Default device launcher, 2 = ME MDM custom launcher. Default: 2

allowed_appsJSON Array

List of apps allowed in kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

background_appsJSON Array

List of apps that run in the background during kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

enable_default_appboolean

Whether a default app is launched automatically in kiosk mode. Default: false

default_kiosk_appJSON Array

The default app launched automatically when kiosk mode starts (single app)

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

default_app_launch_modeinteger

Default app launch behavior. Default: 0

default_app_launch_timeoutinteger

Seconds of idle time before the default app is relaunched. Default: 20

wallpaperlong

Wallpaper image file ID

is_wallpaper_removedboolean

Whether the kiosk wallpaper image has been removed. Default: false

show_me_mdm_appboolean

Whether the ME MDM app is visible on the kiosk launcher. Default: true

allow_notification_badgeboolean

Whether notification badges are shown on app icons in kiosk mode. Default: false

allow_task_managerboolean

Whether the task manager is accessible in kiosk mode. Default: true

allow_system_barboolean

Whether the system bar is visible in kiosk mode. Default: true

allow_navigation_barboolean

Whether the navigation bar is visible in kiosk mode. Default: true

allow_status_barboolean

Whether the status bar is visible in kiosk mode. Default: true

allow_status_bar_expansionboolean

Whether the status bar can be expanded in kiosk mode. Default: true

allow_home_buttonboolean

Whether the home button is functional in kiosk mode. Default: true

allow_power_buttonboolean

Whether the power button is functional in kiosk mode. Default: true

allow_back_buttonboolean

Whether the back button is functional in kiosk mode. Default: true

allow_shutdownboolean

Whether the device can be shut down in kiosk mode. Default: true

allow_key_guardboolean

Whether the key guard (lock screen) is enabled in kiosk mode. Default: true

allow_notificationboolean

Whether notifications are shown in kiosk mode. Default: true

allow_system_error_dialogboolean

Whether app crash dialogs are displayed in kiosk mode. Default: false

allow_recent_appsboolean

Whether the recent apps view is accessible in kiosk mode. Default: true

allow_custom_settingsboolean

Whether the custom settings app is enabled in kiosk mode. Default: true

is_stay_awake_on_chargingboolean

Whether the device stays awake while charging in kiosk mode. Default: true

allow_simunlockboolean

Whether SIM unlock is allowed in kiosk mode. Default: true

allow_multiwindowboolean

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

kiosk_custom_settingsJSON Object

Advanced kiosk device feature controls configuration

Show Sub-Attributes

allow_wifiboolean

Whether the user can access Wi-Fi settings in kiosk mode. Default: true

screen_orientationstring

Forced screen orientation. Values: PORTRAIT, LANDSCAPE, AUTO

allow_brightnessboolean

Whether the user can adjust screen brightness. Default: true

screen_timeoutstring

Screen timeout duration 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_lightboolean

Whether the flashlight is accessible in kiosk mode. Default: true

allow_mobile_networkboolean

Whether mobile network settings are accessible. Default: true

allow_mobile_hotspot_settingsboolean

Whether mobile hotspot settings are accessible. Default: true

hotspot_settings_timeoutinteger

Seconds before hotspot settings panel auto-closes. Default: 30

allow_bluetooth_settingsboolean

Whether Bluetooth settings are accessible. Default: true

bluetooth_settings_timeoutinteger

Seconds before Bluetooth settings panel auto-closes. Default: 30

allow_apn_settingsboolean

Whether APN settings are accessible. Default: true

apn_settings_timeoutinteger

Seconds before APN settings panel auto-closes. Default: 30

settings_timeoutinteger

General settings panel timeout in seconds. Default: 30

allow_wifi_network_configurationboolean

Whether the user can add or configure Wi-Fi networks. Default: true

allow_battery_optimizationboolean

Whether battery optimization settings are accessible. Default: true

allow_locale_settingsboolean

Whether language and locale settings are accessible. Default: true

allow_device_passcode_change_settingsboolean

Whether the user can change the device passcode from kiosk mode. Default: true

allow_display_settingsboolean

Whether display settings are accessible. Default: true

battery_optimized_appsJSON Array

List of apps exempt from battery optimization in kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

mobile_data_usageboolean

Whether the user can view or manage mobile data usage. Default: true

default_keyboardboolean

Whether only the default keyboard is allowed. Default: true

allow_location_settingsboolean

Whether location settings are accessible. Default: true

allow_airplane_modeboolean

Whether the user can toggle airplane mode. Default: true

allow_locationboolean

Whether location services are enabled on the device. Default: true

allow_nfc_settingsboolean

Whether NFC settings are accessible. Default: true

allow_datetime_settingsboolean

Whether date and time settings are accessible. Default: true

allow_accessibility_settingsboolean

Whether accessibility settings are accessible. Default: true

auto_distribute_appsboolean

Whether kiosk apps are automatically distributed to the device. Default: true

webclippoliciesJSON Array

List of web shortcuts displayed on the kiosk home screen

Show Sub-Attributes

JSON Object

Show Sub-Attributes

webclip_policy_idlong

Unique identifier of the web shortcut policy

webclip_namestring

Display name of the web shortcut shown on the kiosk home screen

auto_distribute_webappboolean

Whether kiosk web shortcuts are automatically distributed. Default: true

exit_kiosk_passwordstring

Password required to exit kiosk mode (write-only)

idle_refresh_timeoutinteger

Seconds of idle time before web shortcuts are refreshed. -1 = Disabled. Default: -1

clear_cookies_on_idle_timeoutboolean

Whether cookies are cleared when the idle refresh timeout triggers. Default: true

clear_cache_on_idle_timeoutboolean

Whether cache is cleared when the idle refresh timeout triggers. Default: false

screenlayoutsettingsJSON Object

Home screen layout appearance settings (orientation, icon size, text color)

Show Sub-Attributes

orientation_typeinteger

Screen orientation. 0 = User Controlled, 1 = Portrait, 2 = Landscape

allow_change_app_positionboolean

Whether users can rearrange app icons on the home screen

text_colourstring

Icon label text color as a hex color code (e.g., #FFFFFF)

text_sizeinteger

Icon label font size in sp units

icon_sizeinteger

App icon display size in dp units

model_typeinteger

Home screen layout model type

screenlayoutJSON Object

Kiosk home screen page layout structure containing pages, apps, web shortcuts, and folders

Show Sub-Attributes

pagesJSON Array

Array of home screen pages in the kiosk layout

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_nointeger

Page number (sequential order of this page)

page_typeinteger

Page type. 1 = Home screen page, 2 = Dock page

screenpagelayoutJSON Array

Array of items (apps, web shortcuts, folders) placed on this page

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_layout_rowinteger

Row position of this item on the page grid

page_layout_columninteger

Column position of this item on the page grid

page_layout_typeinteger

Item type. 1 = App, 2 = Web shortcut, 3 = Folder

app_idlong

App ID (applicable when page_layout_type=1)

app_namestring

Display name of the app

icon_file_namestring

File name of the custom icon image

display_image_locstring

Display image location path

webclip_namestring

Web shortcut name (applicable when page_layout_type=2)

webclip_policy_idlong

Web shortcut policy ID (applicable when page_layout_type=2)

folder_namestring

Folder display name (applicable when page_layout_type=3)

folderpagesJSON Array

Array of pages inside this folder (applicable when page_layout_type=3)

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_nointeger

Page number within the folder

page_typeinteger

Page type. 1 = Home screen page, 2 = Dock page

folderpagelayoutJSON Array

Array of items placed on this folder page

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_layout_rowinteger

Row position of this item within the folder page

page_layout_columninteger

Column position of this item within the folder page

page_layout_typeinteger

Item type. 1 = App, 2 = Web shortcut

app_idlong

App ID (applicable when page_layout_type=1)

app_namestring

Display name of the app

webclip_namestring

Web shortcut name (applicable when page_layout_type=2)

display_image_locstring

Display image location path

icon_file_namestring

File name of the custom icon image

webclip_policy_idlong

Web shortcut policy ID (applicable when page_layout_type=2)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Kiosk Homescreen payload item

Copied!

  {
    "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": []
  }

▼ Show full

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.