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 Mac App Notification policy payload item

Request URL

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

app_notification_settingsJSON Array

List of per-app notification settings configured for this payload

Show Sub-Attributes
JSON Object
Show Sub-Attributes
notifications_enabledboolean

Whether notifications are enabled for this app

badges_enabledboolean

Whether badge count is shown on the app icon

alert_typestring

Alert style for notifications. Values: 0=None, 1=Banners (temporary), 2=Alerts (require user action)

show_in_notification_centerboolean

Whether notifications appear in Notification Center

show_in_lock_screenboolean

Whether notifications appear on the Lock Screen

sounds_enabledboolean

Whether notification sounds are played

critical_alert_enabledboolean

Whether critical alerts bypass Do Not Disturb

appsJSON Array

List of app objects associated with this notification setting

Show Sub-Attributes
JSON Object
Show Sub-Attributes
app_namestring

Display name of the app

app_idlong

Unique identifier of the app. 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.