Retrieve all installed configuration profiles from a device

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

gets the list of config profiles installed in device

Request URL

https://{server-hostname}:8383/api/v1/mdm/devices/{device_id}/configurationprofiles

Scope

MDMInventory.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

device_idstringMandatory

Unique identifier of the device. Obtain from the Get Device List response

- Query Parameters

payload_identifierstringOptional
installed_sourceintegerOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/devices/{device_id}/configurationprofiles?payload_identifier=SOME_STRING_VALUE&installed_source=SOME_INTEGER_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
configuration_profilesJSON Array

Array of installed configuration profiles (both user-installed and MDM-installed)

Show Sub-Attributes
JSON Object
Show Sub-Attributes
payload_uuidstring

Unique ID of the configuration profile. Returns 'unknown-uuid' if not available

payload_identifierstring

Payload identifier string (e.g., com.apple.applebetasoftware)

payload_descriptionstring

Full description of the configuration profile

payload_organizationstring

Organization name that created the profile

payload_typestring

Apple-defined payload type

payload_versioninteger

Payload version number

payload_has_rem_passwordboolean

Whether the payload is removable with a password

payload_is_encryptedboolean

Whether the payload content is encrypted

payload_display_namestring

Display name of the configuration profile

payload_unremovableboolean

Whether the payload cannot be removed from the device

payloadcontentJSON Array

Array of individual payload content items within this profile

Show Sub-Attributes
JSON Object
Show Sub-Attributes
payload_uuidstring

Unique identifier of the payload content item

payload_identifierstring

Payload identifier string

payload_descriptionstring

Description of the payload content

payload_organizationstring

Organization that created the payload

payload_typestring

Apple-defined payload type (e.g., com.apple.defaults.managed)

payload_versioninteger

Payload version number

payload_display_namestring

Display name of the payload content

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

MDM-installed and user-installed configuration profiles with payload details

Copied!
  {
    "configuration_profiles": [
      {
        "payload_type": "com.apple.defaults.managed",
        "payload_has_rem_password": false,
        "payload_version": 1,
        "payload_identifier": "com.apple.applebetasoftware",
        "payload_uuid": "unknown-uuid",
        "payload_organization": "Unknown",
        "payloadcontent": [
          {
            "payload_type": "com.apple.defaults.managed",
            "payload_version": 1,
            "payload_identifier": "com.apple.applebetasoftware.payload1",
            "payload_uuid": "unknown-uuid",
            "payload_organization": "Unknown",
            "payload_description": "No description available",
            "payload_display_name": "Payload 1"
          }
        ],
        "payload_is_encrypted": false,
        "payload_description": "No description available",
        "payload_display_name": "iOS Configuration Payload",
        "payload_unremovable": false
      }
    ]
  }
                
Show full

Duration: 1 minute | Threshold: 250 | 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.