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

To get Ios Lock Screen Message payload item

## Endpoints

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

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/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-get-lock-screen-message-payload-ios.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/ioslockscreenmessage/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/ioslockscreenmessage/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/ioslockscreenmessage/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/ioslockscreenmessage/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/ioslockscreenmessage/payloaditems/{payload_id}' -Method GET -Headers $headers
```

## Response Parameters

### HTTP 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/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response.

- **messages** (array of objects)  
  List of lock screen messages
  - **message** (string)  
    Message text to display on lock screen
  - **text_colour** (string)  
    Text colour hex code (e.g. `#FFFFFF`)
  - **offset_position** (integer)  
    Vertical offset position of the message

- **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",
  "messages": [
    {
      "message": "Zylker message",
      "text_colour": "#000000",
      "offset_position": 0
    }
  ],
  "wallpaper_modified": false,
  "orientation": 1
}
```

## Rate Limit

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