apple_device-management/mdm/commands/application.installed.list.yaml

title: Application List Command
description: This command allows the server to query for installed 3rd party applications.
payload:
  requesttype: InstalledApplicationList
  supportedOS:
    iOS:
      introduced: '5.0'
      accessrights: AllowQueryApplications
      supervised: false
      requiresdep: false
      sharedipad:
        mode: allowed
        devicechannel: true
        userchannel: false
      userenrollment:
        mode: allowed
    macOS:
      introduced: '10.7'
      accessrights: AllowQueryApplications
      devicechannel: true
      userchannel: true
      requiresdep: false
      userenrollment:
        mode: forbidden
    tvOS:
      introduced: '10.2'
      accessrights: AllowQueryApplications
      supervised: false
    watchOS:
      introduced: '10.0'
      accessrights: AllowQueryApplications
      supervised: false
  content: This command allows the server to query for installed 3rd party applications.
payloadkeys:
- key: Identifiers
  supportedOS:
    iOS:
      introduced: '7.0'
    macOS:
      introduced: '10.15'
  type: <array>
  presence: optional
  content: An array of app identifiers. Provide this value to limit the response to
    only include these apps. This value is available in iOS 7 and later, macOS 10.15
    and later, and tvOS 10.2 and later.
  subkeys:
  - key: IdentifiersItem
    type: <string>
- key: ManagedAppsOnly
  supportedOS:
    iOS:
      introduced: '7.0'
    macOS:
      introduced: '10.15'
  type: <boolean>
  presence: optional
  default: false
  content: If 'true', only get a list of managed apps. This value is available in
    iOS 7 and later, macOS 10.15 and later, and tvOS 10.2 and later.
- key: Items
  supportedOS:
    iOS:
      introduced: '14.0'
    macOS:
      introduced: n/a
    tvOS:
      introduced: '14.0'
  type: <array>
  presence: optional
  content: An array of strings representing keys in the InstalledApplicationListItem
    dictionary. If provided, the response will contain only the keys listed here.
    The "Identifier" key is always included. If not present, the response will contain
    all keys. Always request just the set of keys that will actually be used, as some
    key values can take significant time and power to calculate on the device.
  subkeys:
  - key: ItemsItem
    type: <string>
    rangelist:
    - AdHocCodeSigned
    - AppStoreVendable
    - BetaApp
    - BundleSize
    - DeviceBasedVPP
    - DynamicSize
    - ExternalVersionIdentifier
    - HasUpdateAvailable
    - Identifier
    - Installing
    - IsAppClip
    - IsValidated
    - Name
    - ShortVersion
    - Version
responsekeys:
- key: InstalledApplicationList
  type: <array>
  presence: required
  content: An array of dictionaries that describes each installed app.
  subkeys:
  - key: InstalledApplicationListItem
    type: <dictionary>
    subkeys:
    - key: Identifier
      type: <string>
      presence: optional
      content: The app's identifier. This key will always be present on iOS/tvOS but
        may be missing on macOS.
    - key: ExternalVersionIdentifier
      supportedOS:
        iOS:
          introduced: '11.0'
        macOS:
          introduced: '10.13'
        tvOS:
          introduced: '11.0'
      type: <integer>
      presence: optional
      content: |-
        The app's external version identifier, which you can use in the iTunes Search API to determine if an updated version of the app is available. Compare this value to the 'externalId' value in the 'contentMetadataLookupUrl' response from the 'VPPServiceConfigSrv' endpoint. If these values don't match, an updated version of the app may be available.
        A newer version of an app may not be available for installation on the device for a variety of reasons, including that the device's operating system version or hardware is incompatible with the available version of the app.
    - key: Version
      type: <string>
      presence: optional
      content: The app's version.
    - key: ShortVersion
      supportedOS:
        iOS:
          introduced: '5.0'
      type: <string>
      presence: optional
      content: The app's short version.
    - key: Name
      type: <string>
      presence: optional
      content: The app's name.
    - key: BundleSize
      supportedOS:
        macOS:
          introduced: '10.7'
      type: <integer>
      presence: optional
      content: The app's static bundle size, in bytes. This value is available in
        iOS 5 and later, and macOS 10.7 and later, and tvOS 10.2 and later.
    - key: DynamicSize
      supportedOS:
        iOS:
          introduced: '5.0'
        macOS:
          introduced: n/a
      type: <integer>
      presence: optional
      content: The size of the app's file system in bytes, including the Documents,
        Library, and other directories. This value is available in iOS 5 and later,
        and tvOS 10.2 and later.
    - key: IsValidated
      supportedOS:
        iOS:
          introduced: '9.2'
        macOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      content: If 'true', the app is valid and can run on the device. If the app is
        enterprise-distributed and unvalidated, it won't be able to run until validation
        has occurred. This value is available in iOS 9.2 and later, and tvOS 10.2
        and later.
    - key: Installing
      type: <boolean>
      presence: optional
      content: If 'true', the app is downloading. If 'false', it's already installed.
    - key: AppStoreVendable
      supportedOS:
        iOS:
          introduced: '11.3'
        macOS:
          introduced: n/a
        tvOS:
          introduced: '11.3'
      type: <boolean>
      presence: optional
      content: If 'true', the app came from the App Store and can participate in store
        features. For device-based Volume Purchase Program (VPP) apps, this value
        is 'false'. This value is available in iOS 11.3 and later, and tvOS 11.3 and
        later.
    - key: DeviceBasedVPP
      supportedOS:
        iOS:
          introduced: '11.3'
        macOS:
          introduced: n/a
        tvOS:
          introduced: '11.3'
      type: <boolean>
      presence: optional
      content: If 'true', installing the app didn't require an Apple ID. This value
        is available in iOS 11.3 and later, and tvOS 11.3 and later.
    - key: BetaApp
      supportedOS:
        iOS:
          introduced: '11.3'
        macOS:
          introduced: n/a
        tvOS:
          introduced: '11.3'
      type: <boolean>
      presence: optional
      content: If 'true', the app is part of the Apple Beta Software Program. This
        value is available in iOS 11.3 and later, and tvOS 11.3 and later.
    - key: AdHocCodeSigned
      supportedOS:
        iOS:
          introduced: '11.3'
        macOS:
          introduced: n/a
        tvOS:
          introduced: '11.3'
      type: <boolean>
      presence: optional
      content: If 'true', the app is ad-hoc code signed. This query is available in
        iOS 11.3 and later, and tvOS 11.3 and later.
    - key: HasUpdateAvailable
      supportedOS:
        iOS:
          introduced: '11.3'
        macOS:
          introduced: 10.13.4
      type: <boolean>
      presence: optional
      content: If 'true', the app has an update available. This key is present only
        for App Store apps. In macOS, this key is present only for Volume Purchase
        Program (VPP) apps. This status updates daily and isn't always up-to-date
        when installing an app.
    - key: DownloadFailed
      type: <boolean>
      presence: optional
      default: false
      content: If 'true', the download failed.
    - key: DownloadWaiting
      type: <boolean>
      presence: optional
      default: false
      content: If 'true', the app is in the initial state, which is waiting to download.
    - key: DownloadPaused
      type: <boolean>
      presence: optional
      default: false
      content: If 'true', the user paused the download.
    - key: DownloadCancelled
      type: <boolean>
      presence: optional
      default: false
      content: If 'true', the user canceled the download.
    - key: IsAppClip
      supportedOS:
        iOS:
          introduced: '16.0'
        macOS:
          introduced: n/a
        tvOS:
          introduced: n/a
        watchOS:
          introduced: n/a
      type: <boolean>
      presence: optional
      default: false
      content: If 'true', the app is an App Clip. Available in iOS 16 and later.