# Retrieve the full configuration details of a Restrictions payload item To get Restrictions policy payload item ## Endpoints **GET** `/api/v1/mdm/profiles/{profile_id}/payloads/restrictionspolicy/payloaditems/{payload_id}` ## Request URL ``` https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/restrictionspolicy/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-restrictions-payload2.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/restrictionspolicy/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/restrictionspolicy/payloaditems/{payload_id}")) .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("GET", HttpRequest.BodyPublishers.noBody()) .build(); HttpResponse 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/restrictionspolicy/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/restrictionspolicy/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/restrictionspolicy/payloaditems/{payload_id}' -Method GET -Headers $headers ``` ## Response Parameters ### HTTP 200 **Response Body**: `application/json` Type: JSON object #### Attributes - **payload_id** (long) Unique identifier of the payload item. - **allow_app_installation** (boolean) Allow App Installation. Default: true. - **allow_app_removal** (boolean) Allow App Removal. Default: true. - **allow_use_of_camera** (boolean) Allow Use Of Camera. Default: true. - **allow_face_time** (boolean) Allow Face Time. Default: true. - **allow_airdrop** (boolean) Allow Airdrop. Default: true. - **allow_imessage** (boolean) Allow Imessage. Default: true. - **allow_modifi_passcode** (boolean) Allow Modifi Passcode. Default: true. - **allow_screen_capture** (boolean) Allow Screen Capture. Default: true. - **allow_sync_while_roaming** (boolean) Allow Sync While Roaming. Default: true. - **allow_assistant** (boolean) Allow Assistant. Default: true. - **allow_assistant_when_locked** (boolean) Allow Assistant When Locked. Default: true. - **force_assist_profanity_filter** (boolean) Force Assist Profanity Filter. Default: false. - **allow_assistant_user_content** (boolean) Allow Assistant User Content. Default: true. - **allow_touch_id** (boolean) Allow Touch Id. Default: true. - **allow_passbook_when_locked** (boolean) Allow Passbook When Locked. Default: true. - **show_control_center** (boolean) Show Control Center. Default: true. - **show_notification_center** (boolean) Show Notification Center. Default: true. - **show_today_view** (boolean) Show Today View. Default: true. - **allow_voice_dialing** (boolean) Allow Voice Dialing. Default: true. - **allow_inapp_purchase** (boolean) Allow Inapp Purchase. Default: true. - **force_istore_pwd_entry** (boolean) Force Istore Pwd Entry. Default: false. - **allow_game_center** (boolean) Allow Game Center. Default: true. - **allow_multiplayer_gaming** (boolean) Allow Multiplayer Gaming. Default: true. - **allow_add_game_center_friend** (boolean) Allow Add Game Center Friend. Default: true. - **allow_use_of_youtube** (boolean) Allow Use Of Youtube. Default: true. - **allow_use_of_ibookstore** (boolean) Allow Use Of Ibookstore. Default: true. - **allow_ibookstore_erotica_media** (boolean) Allow Ibookstore Erotica Media. Default: true. - **allow_itunes** (boolean) Allow Itunes. Default: true. - **allow_safari** (boolean) Allow Safari. Default: true. - **safari_allow_autofill** (boolean) Safari Allow Autofill. Default: true. - **safari_force_fraud_warning** (boolean) Safari Force Fraud Warning. Default: false. - **safari_allow_javascript** (boolean) Safari Allow Javascript. Default: true. - **safari_allow_popups** (boolean) Safari Allow Popups. Default: true. - **safari_accept_cookies** (integer) Safari cookie acceptance policy. Allowed values: 0 = Never 1 = From current website only 2 = Always Default: 2. - **allow_cloud_backup** (boolean) Allow Cloud Backup. Default: true. - **allow_cloud_document_sync** (boolean) Allow Cloud Document Sync. Default: true. - **allow_photo_stream** (boolean) Allow Photo Stream. Default: true. - **allow_shared_stream** (boolean) Allow Shared Stream. Default: true. - **allow_diagnostic_submission** (boolean) Allow Diagnostic Submission. Default: true. - **allow_untrusted_tls_prompt** (boolean) Allow Untrusted Tls Prompt. Default: true. - **allow_ota_pki_updates** (boolean) Allow Ota Pki Updates. Default: true. - **force_encrypted_backup** (boolean) Force Encrypted Backup. Default: false. - **force_limited_ad_tracking** (boolean) Force Limited Ad Tracking. Default: false. - **allow_profile_installation** (boolean) Allow Profile Installation. Default: true. - **allow_account_modification** (boolean) Allow Account Modification. Default: true. - **allow_find_my_friends_mod** (boolean) Allow Find My Friends Mod. Default: true. - **allow_host_pairing** (boolean) Allow Host Pairing. Default: true. - **allow_app_cellular_data** (boolean) Allow App Cellular Data. Default: true. - **allow_open_doc_in_unmanaged** (boolean) Allow Open Doc In Unmanaged. Default: true. - **allow_open_doc_in_managed** (boolean) Allow Open Doc In Managed. Default: true. - **allow_explicit_content** (boolean) Allow Explicit Content. Default: true. - **is_rating_enabled** (boolean) Is Rating Enabled. Default: false. - **country_code** (string) Country Code. Default: us. - **movies_rating_value** (integer) Movie content rating filter. US values: 0 = Don't Allow 100 = G 200 = PG 300 = PG-13 400 = R 500 = NC-17 1000 = Allow All Movies Default: 1000. - **tv_shows_rating_value** (integer) TV show content rating filter. US values: 0 = Don't Allow 100 = TV-Y 200 = TV-Y7 300 = TV-G 400 = TV-PG 500 = TV-14 600 = TV-MA 1000 = Allow All TV Shows Default: 1000. - **apps_rating_value** (integer) App Store content rating filter. US values: 0 = Don't Allow 100 = 4+ 200 = 9+ 300 = 12+ 600 = 17+ 1000 = Allow All Apps Default: 1000. - **allowed_camera_restriction_app_id** (array of long) List of app IDs allowed to use the camera when camera is restricted. Use the app_group_id from the [Apps API](https://www.manageengine.com/mobile-device-management/help/api/cloud/app-management-get-an-app.html) response. - **default_browser_app_details** (JSON object) Default Browser App Details. - **default_calling_app_details** (JSON object) Default Calling App Details. - **default_messaging_app_details** (JSON object) Default Messaging App Details. - **allow_rcs_messaging** (boolean) Allow Rcs Messaging. Default: true. - **allow_call_recording** (boolean) Allow Call Recording. Default: true. - **allow_apps_to_be_locked** (boolean) Allow Apps To Be Locked. Default: true. - **allow_apps_to_be_hidden** (boolean) Allow Apps To Be Hidden. Default: true. - **allow_visual_intelligence_summarization** (boolean) Allow Visual Intelligence Summarization. Default: true. - **allow_apple_intelligence_report** (boolean) Allow Apple Intelligence Report. Default: true. - **allow_mail_smart_replies** (boolean) Allow Mail Smart Replies. Default: true. - **allow_safari_summary** (boolean) Allow Safari Summary. Default: true. - **allow_default_calling_app_modification** (boolean) Allow Default Calling App Modification. Default: true. - **allow_default_messaging_app_modification** (boolean) Allow Default Messaging App Modification. Default: true. ## Sample Response: HTTP 200 Full configuration details of Restrictions payload item ```json { "payload_id": 9007199254741000, "allow_app_installation": true, "allow_face_time": true, "allow_assistant": true, "allow_modifi_passcode": true, "allow_use_of_camera": true, "allow_app_removal": true, "allow_airdrop": true, "allow_screen_capture": true, "allow_imessage": true, "allow_sync_while_roaming": true } ``` ## Possible Response Codes - **200** – HTTP code ## 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.