--- title: "Retrieve a configured Software Application." method: GET path: "/api/v2/softwareapps/{id}" tags: ["Software Apps"] --- # Retrieve a configured Software Application. `GET /api/v2/softwareapps/{id}` ## Request - Base URL: `https://console.jumpcloud.com` - URL: `https://console.jumpcloud.com/api/v2/softwareapps/{id}` - Auth: API key in header `x-api-key` - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves a Software Application. The optional isConfigEnabled and appConfiguration apple_vpp attributes are populated in this response. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/v2/softwareapps/{id} \ -H 'accept: application/json' \ -H 'content-type: application/json' \ -H 'x-api-key: {API_KEY}' ``` ## Headers - `x-org-id` string ## Response `200` OK - SoftwareApp - `id` string - `organization` string: The owning organization ID. - `displayName` string - `createdAt` string, date-time, nullable - `updatedAt` string, date-time, nullable - `settings` SoftwareAppSettings[] - `packageId` string - `autoUpdate` boolean - `allowUpdateDelay` boolean - `packageManager` string: App store serving the app: APPLE_VPP, CHOCOLATEY, etc. - `locationObjectId` string: ID of the repository where the app is located within the package manager - `location` string: Repository where the app is located within the package manager - `desiredState` string: State of Install or Uninstall - `adminIntent` 'INTENT_UNSPECIFIED' | 'INTENT_FORCE_MANAGED' | 'INTENT_FORCE_UNMANAGED' - `managedInstallEligibilityStatus` 'MANAGED_INSTALL_ELIGIBILITY_NOT_EVALUATED' | 'MANAGED_INSTALL_ELIGIBLE' | 'MANAGED_INSTALL_INELIGIBLE' | 'MANAGED_INSTALL_ELIGIBILITY_UNKNOWN' - `detectionRules` object: Rules used to detect if the software app is installed on Windows. - `ruleType` string - `expectedDisplayName` string - `registryPath` string - `registryValueName` string - `registryExpectedValue` string - `powerShellScript` string - `appleVpp` SoftwareAppAppleVpp: appleVpp is an optional attribute, it will only be present on apps with a 'setting' 'package_manager' type of 'APPLE_VPP'. - `appConfiguration` string: Text sent to configure the application, the text should be a valid plist. Returned only by 'GET /softwareapps/{id}'. - `assignedLicenses` integer - `availableLicenses` integer - `details` object: App details returned by iTunes API. See example. The properties in this field are out of our control and we cannot guarantee consistency, so it should be checked by the client and manage the details accordingly. - `isConfigEnabled` boolean: Denotes if configuration has been enabled for the application. Returned only by ''GET /softwareapps/{id}''. - `supportedDeviceFamilies` string[]: The supported device families for this VPP Application. - `totalLicenses` integer - `packageSubtitle` string: The package manifest subtitle. - `displayVersion` string: Optional display version for the software app. Defaults to "Version N" when omitted. - `packageVersion` string: The package manifest version. - `packageKind` string: The package manifest kind (ex: software-package). - `assetKind` string: The manifest asset kind (ex: software). - `assetSha256Size` integer: The incremental size to use for summing the package as it is downloaded. - `assetSha256Strings` string[]: The array of checksums, one each for the hash size up to the total size of the package. - `description` string: The software app description. - `googleAndroid` SoftwareAppGoogleAndroid: googleAndroid is an optional attribute, it will only be present on apps with a 'setting' 'package_manager' type of 'GOOGLE_ANDROID'. - `name` string: The name of the app in the form enterprises/{enterprise}/applications/{packageName}. - `type` 'APP_TYPE_UNSPECIFIED' | 'PUBLIC' | 'PRIVATE' | 'WEBAPP': Type of this android application. - `iconUrl` string: A link to an image that can be used as an icon for the app. - `author` string: The name of the author of this app. - `category` string: The app category (e.g. COMMUNICATION, SOCIAL, etc.). - `appPricing` string: Whether this app is free, free with in-app purchases, or paid. - `distributionChannel` string: How and to whom the package is made available. - `minSdkVersion` integer: The minimum Android SDK necessary to run the app. - `contentRating` string: The content rating for this app. - `updateTime` string: The approximate time (within 7 days) the app was last published. - `appVersion` string: Latest version currently available for this app. - `fullDescription` string: Full app description, if available. - `startUrl` string: The start URL, i.e. the URL that should load when the user opens the application. Applicable only for webapps. - `displayMode` string: The display mode of the web app. - `versionCode` integer: The current version of the web app. - `managedProperties` boolean: Indicates whether this app has managed properties or not. - `autoUpdateMode` 'AUTO_UPDATE_DEFAULT' | 'AUTO_UPDATE_POSTPONED' | 'AUTO_UPDATE_HIGH_PRIORITY': Controls the auto-update mode for the app. - `runtimePermission` 'PROMPT' | 'GRANT' | 'DENY': The policy for granting permission requests to apps. - `installType` 'AVAILABLE' | 'FORCE_INSTALLED' | 'BLOCKED': The type of installation to perform for an app. - `managedConfigurationTemplateId` string: The managed configurations template for the app. - `permissionGrants` SoftwareAppPermissionGrants[] - `id` string: An opaque string uniquely identifying the Android permission, e.g. android.permission.READ_CALENDAR. - `policy` 'PROMPT' | 'GRANT' | 'DENY': The policy for granting the permission. - `androidFeatures` string[]: The array of android features for the app. - `enterpriseObjectId` string: ID of the Enterprise with which this app is associated - `commandLineArguments` string: Command line arguments to use with the application. - `storedPackage` ObjectStorageItem: Object storage item information. - `objectId` string - `versions` ObjectStorageVersion[] - `name` string - `version` integer - `size` integer - `sha256sum` string - `status` string - `rejectedReason` string - `displayVersion` string: Admin-defined display label for this package version. - `createdAt` string, date-time: When this package version was created. - `updatedAt` string, date-time: When this package version was last updated. - `metadata` object: Parsed package metadata for the uploaded file (e.g. EXE code-signing subject). - `metadataExe` object - `installerEngineVersion` string: Installer engine identifier/version from EXE metadata (e.g. NSIS, Inno Setup). - `signatureLabel` string - `storedPackageObjectId` string: ID of the stored package this app uses to reference the stored install media. - `microsoftStore` SoftwareAppMicrosoftStore: microsoftStore is an optional attribute, it will only be present on apps with a 'setting' 'package_manager' type of 'MICROSOFT_STORE'. - `packageFamilyName` string: Package Family Name for the app from Microsoft App Store. - `nonRemovable` boolean: Indicates whether the app is removable by the users or not. - `doNotUpdate` boolean: Indicates whether the app can be updated or not. - `scope` string: The installation scope of the software app. - `appCatalogInstallableObjectId` string: ID of the app catalog installable that created this app. - `iconUrl` string: URL to the icon for the app. - `installerEngineVersion` string: Installer engine/version from EXE object-storage metadata (read-only on GET). - `versionlessDownloadUrl` boolean - `bundleId` string - `teamId` string - `format` string - `appFileName` string - `shortVersion` string - `signatureLabel` string: Code-signing subject from EXE object-storage metadata (read-only on GET). - `silentInstallFlags` string[]: Admin override for silent install arguments (Windows custom EXE). - `downloadUrl` string - `architectures` string[] - `updateTool` string - `updateToolArguments` string - `uninstallOnUnbind` boolean - `unsafeUninstall` boolean - `autoUpdateNotificationsDisabled` boolean - `installerType` string: Winget installer format (e.g. "msix"); empty means the default winget installer. - `packageFamilyName` string: MSIX package family name (DisplayName_PublisherId) used for machine-wide MSIX installs. - `migrationSafe` boolean: Whether migrating an existing install to the configured installer type has been validated as safe. - `appDeliveryMethod` string - `createdAt` string, date-time, nullable - `updatedAt` string, date-time, nullable - `packageVersionUpdatedAt` string, date-time, nullable ## Other responses - `400`: Bad Request - `401`: Unauthenticated - `403`: Unauthorized - `404`: Not Found - `409`: Conflict - `500`: Internal Server Error --- [API](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api.md) - [All operations](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/llms.txt) - [OpenAPI document](https://skmtc.dev/jumpcloud/apis/jumpcloud-console-api/revisions/f396d9271b46?raw)