Retrieve the full configuration details of a App Notification payload item 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
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters profile_id string Mandatory
payload_id string Mandatory
- Query Parameters include string Optional
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
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'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/iosappnotificationpolicy/payloaditems/{payload_id}?include=payloaditems"))
.header("Accept", "application/json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = {
'Accept': "application/json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("GET", "/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy/payloaditems/{payload_id}?include=payloaditems", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
parameters = "include=value";
headersMap = Map();
headersMap.put("Accept", "application/json");
response = invokeUrl
[
url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy/payloaditems/{payload_id}" + "?" + parameters
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy/payloaditems/{payload_id}?include=payloaditems' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes payload_id long
Unique identifier of the payload item
app_notification_settings JSON Array
List of per-app notification settings
Show Sub-Attributes JSON Object
Show Sub-Attributes notifications_enabled boolean
Whether notifications are enabled for this app. Default: true
badges_enabled boolean
Whether badge count is shown. Default: true
alert_type integer
Alert style. Allowed values: 0=None, 1=Banners (temporary), 2=Alerts (require action)
preview_type integer
Notification preview type. Allowed values: 0=Always, 1=When Unlocked, 2=Never
grouping_type integer
Notification grouping. Allowed values: 0=Automatic, 1=By App, 2=Off
show_in_notification_center boolean
Show in Notification Center. Default: true
show_in_lock_screen boolean
Show on Lock Screen. Default: true
show_in_car_play boolean
Show in CarPlay. Default: true
sounds_enabled boolean
Whether notification sounds are enabled. Default: true
critical_alert_enabled boolean
Whether critical alerts are enabled. Default: false
apps array
List of app IDs (long) for this notification setting. Use the app_group_id from the Apps API response
Possible Response Codes 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.