# Retrieve the full configuration details of a Lock Screen Message payload item

Get Android Lock screen payload

## Endpoints

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

## Request URL

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

## Scope

`MDMDeviceMgmt.READ`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** `string` — Mandatory  
  `application/json`

### Path Parameters

- **profile_id** `string` — Mandatory  
  Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-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/products/desktop-central/help/api/onpremise/android-get-lock-screen-message-payload-android.html) response.

## Sample Request

### Curl

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

## Response Parameters

### HTTP Code 200

#### Response Body — application/json

`JSON Object`

- **payload_id** `long`  
  Unique identifier of the payload item.

- **wallpaper_type** `integer`  
  Wallpaper type. 1 = Custom color wallpaper, 2 = Uploaded image wallpaper, 3 = Uploaded image with separate landscape image (required).

- **bg_colour** `string`  
  Background hex color code for custom wallpaper (applies when `wallpaper_type=1`, e.g., `#FFFFFF`).

- **wallpaper** `long`  
  Wallpaper image file ID (applies when `wallpaper_type=2` or `3`).

- **landscape_wallpaper** `long`  
  Landscape wallpaper image file ID (applies when `wallpaper_type=3`).

- **messages** `JSON Array`  
  Array of messages displayed on the lock screen (required, max 5 messages).

- **wallpaper_modified** `boolean`  
  Whether the wallpaper image has been modified.

- **landscape_wallpaper_modified** `boolean`  
  Whether the landscape wallpaper image has been modified.

- **orientation** `integer`  
  Lock screen message orientation. 0 = User Controlled, 1 = Portrait, 2 = Landscape. Default: 1.

- **asset_tag_show_option** `integer`  
  Asset tag display location. 0 = Lock screen, 1 = Kiosk launcher, 2 = Lock screen and kiosk launcher. Default: 0.

- **asset_tag_text_size** `integer`  
  Asset tag text size. 1 = Small, 2 = Medium, 3 = Large. Default: 1.

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

Full configuration details of Lock Screen Message payload item

```json
{
  "payload_id": 9007199254741000,
  "orientation": 1,
  "wallpaper": 9007199254741080,
  "wallpaper_modified": false,
  "messages": [
    {
      "text_colour": "#000000",
      "message": "This device belongs to Example Corp"
    }
  ],
  "wallpaper_type": 2,
  "landscape_wallpaper": 0,
  "bg_colour": "#ffffff",
  "landscape_wallpaper_modified": false
}
```

![ ](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

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