# Retrieve the full configuration details of a App Lock Homescreen payload item

To get App Lock Home Screen policy payload item

## Endpoints

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

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/applockhomescreenpolicy/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/ios_getapplockhomescreenpayloadios.html) response.

### Query Parameters

- **t** (long) — Optional  
- **ignoreHeader** (boolean) — Optional  
- **qlt** (long) — Optional  
- **previousTab** (string) — Optional  
- **service** (string) — Optional  
- **search** (string) — Optional  
  Free-text search string applied to the default searchable fields of the resource.
- **all** (boolean) — Optional  
- **dc_customerid** (long) — Optional  
- **mdm_instance** (string) — Optional  
- **signupsrc** (string) — Optional  
- **zaaid** (string) — Optional  
- **command** (string) — Optional  
- **orderby** (string) — Optional  
- **sortorder** (string) — Optional  
- **select_all** (boolean) — Optional  
  When true, applies the operation to every record matching the current filter rather than to specific IDs. Default: false.
- **zoho-internal** (boolean) — Optional  
- **dc_instance** (string) — Optional  
- **SUBREQUEST** (string) — Optional  
- **source** (string) — Optional  
- **nocache** (long) — Optional  
  Param to avoid being served from cache.
- **wms_csrparam** (string) — Optional  
  CSRF Token.

## Sample Request

### Curl

```bash
curl --request GET \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/applockhomescreenpolicy/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/applockhomescreenpolicy/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/applockhomescreenpolicy/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/applockhomescreenpolicy/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/applockhomescreenpolicy/payloaditems/{payload_id}' -Method GET -Headers $headers
```

## Response Parameters

### HTTP 200

**Response Body**: `application/json`  
JSON object

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

- **idle_refresh_timeout** (integer)  
  Idle refresh timeout for web app kiosk in seconds. -1 means disabled. Default: -1.

- **clear_session_and_cookies** (boolean)  
  Clear Session And Cookies. Default: true.

- **webclippolicies** (array of objects)  
  List of web clips configured for kiosk mode.
  - **webclip_policy_id** (long)  
    Web clip policy ID.
  - **webclip_name** (string)  
    Display name of the web clip.

- **auto_distribute_webapp** (boolean)  
  Auto Distribute Webapp. Default: true.

- **app_name** (string)  
  App Name.

- **identifier** (string)  
  Identifier.

- **disable_touch** (boolean)  
  Disable Touch. Default: false.

- **disable_device_rotation** (boolean)  
  Disable Device Rotation. Default: false.

- **disable_volume_buttons** (boolean)  
  Disable Volume Buttons. Default: false.

- **disable_ringer_switch** (boolean)  
  Disable Ringer Switch. Default: false.

- **disable_sleep_button** (boolean)  
  Disable Sleep Button. Default: false.

- **disable_auto_lock** (boolean)  
  Disable Auto Lock. Default: true.

- **voice_over** (boolean)  
  Voice Over. Default: false.

- **zoom** (boolean)  
  Zoom. Default: false.

- **invert_colors** (boolean)  
  Invert Colors. Default: false.

- **asst_touch** (boolean)  
  Asst Touch. Default: false.

- **enable_speak_selection** (boolean)  
  Enable Speak Selection. Default: false.

- **enable_mono_audio** (boolean)  
  Enable Mono Audio. Default: false.

- **enable_voice_control** (boolean)  
  Enable Voice Control. Default: false.

- **show_me_mdm_app** (boolean)  
  Show Me Mdm App. Default: true.

- **kiosk_mode** (integer)  
  Kiosk mode type. Allowed values:  
  - `1` = Single App Kiosk  
  - `2` = Multi App Kiosk  
  - `3` = Single Web App Kiosk  

- **allowed_apps** (array of objects)  
  List of allowed kiosk apps.
  - **app_id** (long)  
    App ID of the kiosk app. Use the app_group_id from the [Apps API](https://www.manageengine.com/mobile-device-management/help/api/cloud/app-management-get-an-app.html) response.
  - **group_display_name** (string)  
    Display name of the app group.

- **autonomous_kiosk_apps** (array of objects)  
  List of autonomous single app mode apps.
  - **app_id** (long)  
    App ID of the kiosk app. Use the app_group_id from the [Apps API](https://www.manageengine.com/mobile-device-management/help/api/cloud/app-management-get-an-app.html) response.
  - **group_display_name** (string)  
    Display name of the app group.

- **auto_distribute_apps** (boolean)  
  Auto Distribute Apps. Default: false.

- **screenlayoutsettings** (object)  
  Screen layout settings.

- **screenlayout** (object)  
  Screen layout.

## Sample Response: HTTP 200

Full configuration details of App Lock Homescreen payload item

```json
{
  "app_name": "Zylker User",
  "identifier": "value",
  "payload_id": 9007199254741000,
  "disable_volume_buttons": false,
  "disable_ringer_switch": false,
  "idle_refresh_timeout": -1,
  "webclippolicies": [
    {
      "webclip_policy_id": 9007199254741076,
      "webclip_name": "Zylker Web Clip"
    }
  ],
  "clear_session_and_cookies": true,
  "disable_touch": false,
  "disable_device_rotation": false,
  "kiosk_mode": 1,
  "auto_distribute_webapp": true
}
```

## Possible Response Codes

- **200** — HTTP code

## 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.