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

To get Ios Lock Screen Message payload item

## Endpoint

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

## Request

### Request URL

`https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/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/ios-get-lock-screen-message-payload-ios.html) response.

### Sample Request

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

## Response

### Response Parameters

#### HTTP Code 200

Response Body: `application/json`

- **payload_id** (`long`): Unique identifier of the payload item.
- **wallpaper_type** (`integer`): Wallpaper type for lock screen. Allowed values: `1=Background Color`, `2=Uploaded Image`.
- **bg_colour** (`string`): Bg Colour.
- **wallpaper** (`long`): Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/files-upload-file-ems.html) response.
- **messages** (`JSON Array`): List of lock screen messages.
- **wallpaper_modified** (`boolean`): Wallpaper Modified.
- **orientation** (`integer`): Orientation. Default: `1`.

### Possible Response Codes

- **200** (`HTTP code`)

### Sample Response: HTTP 200

Full configuration details of Lock Screen Message payload item

```json
"{                         \"payload_id\": 9007199254741001,                         \"wallpaper_type\": -1,                         \"bg_colour\": \"value\",                         \"wallpaper\": \"value\",                         \"wallpaper\": \"value\",                         \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}],                         \"wallpaper_modified\": false,                         \"orientation\": 1                         }"
```

## Rate Limit

![](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.