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

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Get Android Lock screen payload

Request URL

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

Scope

MDMDeviceMgmt.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/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/androidlockscreenmessage/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

wallpaper_typeinteger

Wallpaper type. 1 = Custom color wallpaper, 2 = Uploaded image wallpaper, 3 = Uploaded image with separate landscape image (required)

bg_colourstring

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

wallpaperlong

Wallpaper image file ID (applies when wallpaper_type=2 or 3)

landscape_wallpaperlong

Landscape wallpaper image file ID (applies when wallpaper_type=3)

messagesJSON Array

Array of messages displayed on the lock screen (required, max 5 messages)

Show Sub-Attributes
JSON Array

Lock screen message entry

Show Sub-Attributes
JSON Object
Show Sub-Attributes
messagestring

Lock screen message text (required, max 100 characters)

text_colourstring

Message text color as a hex color code (required, e.g., #FF0000)

orderinteger

Display order of this message on the lock screen

wallpaper_modifiedboolean

Whether the wallpaper image has been modified

landscape_wallpaper_modifiedboolean

Whether the landscape wallpaper image has been modified

orientationinteger

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

asset_tag_show_optioninteger

Asset tag display location. 0 = Lock screen, 1 = Kiosk launcher, 2 = Lock screen and kiosk launcher. Default: 0

asset_tag_text_sizeinteger

Asset tag text size. 1 = Small, 2 = Medium, 3 = Large. Default: 1

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of Lock Screen Message payload item

Copied!
  {
    "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
  }
                
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.