Retrieve details of a specific app on 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

Get a single app details installed with the device

Request URL

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

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

app_idstringMandatory

Unique identifier of the application. Obtain from the Get App List response

- Query Parameters

limitintegerOptional

Maximum number of records to return in a single response. Used together with offset for pagination

skip-tokenstringOptional

Pagination continuation token returned by a previous response. Pass it to fetch the next page of results

offsetintegerOptional

Zero-based index of the first record to return. Used together with limit for pagination

delta-tokenstringOptional

Token used for delta/incremental fetches. Pass the token returned from a previous response to retrieve only items modified since that point

searchkeystringOptional

Value to search for. Must be used in combination with searchfield to specify which field is searched

searchfieldstringOptional

Name of the field to search against. Used together with searchkey (e.g., name, email, udid)

is_allowed_appsbooleanOptional

Set to true to return apps from the allow list, false to return apps from the block list

is_app_purchased_from_portalbooleanOptional

Set to true to restrict results to apps purchased through the enterprise app portal (VPP/managed Google Play). Default: false

searchstringOptional

Free-text search string applied to the default searchable fields of the resource

app_scopestringOptional

Filter applications by their assignment scope. Allowed values: 1=All, 2=Assigned to groups, 3=Assigned to devices

platformstringOptional

Filter results by device platform. Allowed values: 1=iOS, 2=Android, 3=Windows, 4=macOS, 6=tvOS

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/devices/{device_id}/apps/{app_id}?limit=SOME_INTEGER_VALUE&skip-token=SOME_STRING_VALUE&offset=SOME_INTEGER_VALUE&delta-token=SOME_STRING_VALUE&searchkey=SOME_STRING_VALUE&searchfield=SOME_STRING_VALUE&is_allowed_apps=SOME_BOOLEAN_VALUE&is_app_purchased_from_portal=SOME_BOOLEAN_VALUE&search=SOME_STRING_VALUE&app_scope=SOME_STRING_VALUE&platform=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
islatestverboolean

Whether the app is at its latest available version

localized_remarkstring

Localized remarks for the app status

app_typeinteger

App type: 1 - Store app, 2 - Enterprise app

app_category_namestring

App category name (e.g., Games, Productivity)

is_paid_appstring

Whether the app is a paid app: true or false

app_namestring

Display name of the app

release_label_detailsJSON Object

Release label details for the app version

Show Sub-Attributes
release_label_namestring

Display name of the release label (e.g., Production, Beta)

release_label_idstring

Unique release label identifier

platform_typestring

Platform type (e.g., android, ios, windows)

latest_versionstring

Latest available version of the app

executed_versionstring

Version currently executed on the device

associated_bystring

Username who associated the app to the device

app_idstring

Unique app identifier

associated_onstring

Timestamp when the app was associated

remarksstring

Remarks about the app distribution status

statusstring

Distribution status (e.g., SCHEDULED, INSTALLED, FAILED)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Detailed app info with version, category, and association details

Copied!
  {
    "islatestver": true,
    "localized_remark": "--",
    "app_type": 1,
    "app_category_name": "Games",
    "is_paid_app": "false",
    "app_name": "Red Ball 4 (Ad Supported)",
    "release_label_details": {
      "release_label_name": "Production",
      "release_label_id": "90086789628394940"
    },
    "platform_type": "android",
    "latest_version": "5",
    "executed_version": "1",
    "associated_by": "admin",
    "app_id": "9007199254740995",
    "associated_on": "1522066653883",
    "remarks": "--",
    "status": "SCHEDULED"
  }
                
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.