Retrieve the full configuration details of a App Notification 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

To Get Ios App Notification policy payload item

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy/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

- Query Parameters

includestringOptional

Comma-separated list of related fields to include in the response (e.g., assigned_to, payload_details). When omitted, only top-level fields are returned

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy/payloaditems/{payload_id}?include=payloaditems' \
  --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

app_notification_settingsJSON Array

List of per-app notification settings

Show Sub-Attributes
JSON Object
Show Sub-Attributes
notifications_enabledboolean

Whether notifications are enabled for this app. Default: true

badges_enabledboolean

Whether badge count is shown. Default: true

alert_typeinteger

Alert style. Allowed values: 0=None, 1=Banners (temporary), 2=Alerts (require action)

preview_typeinteger

Notification preview type. Allowed values: 0=Always, 1=When Unlocked, 2=Never

grouping_typeinteger

Notification grouping. Allowed values: 0=Automatic, 1=By App, 2=Off

show_in_notification_centerboolean

Show in Notification Center. Default: true

show_in_lock_screenboolean

Show on Lock Screen. Default: true

show_in_car_playboolean

Show in CarPlay. Default: true

sounds_enabledboolean

Whether notification sounds are enabled. Default: true

critical_alert_enabledboolean

Whether critical alerts are enabled. Default: false

appsarray

List of app IDs (long) for this notification setting. Use the app_group_id from the Apps API response

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Full configuration details of App Notification payload item

Copied!
  {
    "payload_id": 9007199254741000,
    "app_notification_settings": [
      {
        "badges_enabled": true,
        "notifications_enabled": true,
        "alert_type": 1,
        "apps": [
          9007199254741072
        ]
      }
    ]
  }
                
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.