Retrieve detailed information about a specific managed 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 particular device's inventory details

Request URL

https://{server-hostname}:8383/api/v1/mdm/devices/{device_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

- Query Parameters

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

delta-tokenstringOptional

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

skip-tokenstringOptional

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

limitintegerOptional

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

summarybooleanOptional

When true, returns only a lightweight summary projection of the resource instead of full details. Default: false

includestringOptional

Include group name in the response. Allowed value: groupName. When omitted, only top-level fields are returned

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url 'https://appdomain/api/v1/mdm/devices/{device_id}?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&delta-token=SOME_STRING_VALUE&skip-token=SOME_STRING_VALUE&limit=SOME_INTEGER_VALUE&summary=SOME_BOOLEAN_VALUE&include=SOME_STRING_VALUE' \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Warranty number of the device

cellular_technologyinteger

Cellular technology type: 1 - None, 2 - GSM, 3 - CDMA

used_device_spacestring

Amount of device space used (GB)

is_ios_native_app_registeredboolean

Whether the native iOS app is registered on the device

warranty_expiration_datelong

Warranty expiration date in milliseconds since epoch

purchase_order_numberstring

Purchase order number

modelstring

Device model identifier

available_external_capacitystring

Available free external storage space (GB)

available_ram_memoryinteger

Available free RAM in megabytes

owned_bystring

Device ownership: 1 - Corporate, 2 - Personal

warranty_typestring

Type of warranty (e.g., WithService)

modem_firmware_versionstring

Baseband/modem firmware version

purchase_priceinteger

Purchase price of the device

purchase_datelong

Purchase date in milliseconds since epoch

managed_statusinteger

Management status: 0 - Failed, 1 - Yet to enroll, 2 - Enrolled, 3 - Waiting approval, 4 - Unmanaged, 5 - Waiting user assignment

network_usageJSON Object

Network usage details for the device

Show Sub-Attributes
outgoing_network_usageinteger

Outgoing cellular network usage in bytes

incoming_wifi_usageinteger

Incoming Wi-Fi usage in bytes

device_idstring

Device identifier for the network usage record

outgoing_wifi_usageinteger

Outgoing Wi-Fi usage in bytes

incoming_network_usageinteger

Incoming cellular network usage in bytes

simsJSON Array

Array of SIM card details

Show Sub-Attributes
JSON Object
Show Sub-Attributes
subscriber_carrier_networkstring

Home carrier network name

iccidlong

SIM Integrated Circuit Card Identifier

is_roamingboolean

Whether the SIM is currently in roaming

sim_idlong

Unique SIM identifier

current_mncinteger

Current Mobile Network Code

subscriber_mncinteger

Subscriber (home) Mobile Network Code

current_carrier_networkstring

Current carrier network name

resource_idlong

Resource identifier for the SIM record

imeilong

IMEI number associated with the SIM slot

subscriber_mccstring

Home Mobile Country Code

current_mccstring

Current Mobile Country Code

external_capacitystring

Total external storage capacity (GB)

knox_detailsJSON Object

Samsung Knox container details

Show Sub-Attributes
container_statestring

Knox container state (-1 = not applicable)

container_remarksstring

Remarks about the Knox container

container_statusstring

Knox container status code

container_last_updated_timestring

Last updated time of the Knox container

knox_versionstring

Samsung Knox version on the device

asset_ownerstring

Owner of the device asset

apn_passwordstring

APN password

battery_levelinteger

Current battery level percentage

is_itunes_account_activeboolean

Whether the iTunes Store account is active

is_supervisedboolean

Whether the device is supervised (iOS)

serial_numberstring

Device serial number

last_cloud_backup_datestring

Date of last cloud backup (-1 = never backed up)

agent_version_codestring

Agent version code (-1 = not available)

meidstring

Mobile Equipment Identifier

is_dnd_in_effectboolean

Whether Do Not Disturb is currently active

officestring

Office location assigned to the device

apn_usernamestring

APN username

model_namestring

Device model name

registered_timestring

Device registration timestamp

purchase_typestring

Purchase type (e.g., Reseller, Vendor)

asset_tagstring

Asset tag assigned to the device

is_activation_lock_enabledboolean

Whether Activation Lock is enabled (iOS)

available_device_capacitystring

Available free device storage capacity (GB)

product_namestring

Product/manufacturer name

agent_typeinteger

Agent type: 1 - iOS Profile, 2 - Android Core Agent, 3 - SAFE Agent

is_device_locator_enabledboolean

Whether the device locator service is enabled

device_capacitystring

Total device storage capacity (GB)

added_timestring

Timestamp when device was added to management

eas_device_identifierstring

Exchange ActiveSync device identifier

descriptionstring

Description of the device

is_lost_mode_enabledboolean

Whether Lost Mode is enabled

networkJSON Object

Network usage details

Show Sub-Attributes
outgoing_network_usageinteger

Outgoing cellular network usage in bytes

incoming_wifi_usageinteger

Incoming Wi-Fi usage in bytes

device_idstring

Device identifier for the network usage record

outgoing_wifi_usageinteger

Outgoing Wi-Fi usage in bytes

incoming_network_usageinteger

Incoming cellular network usage in bytes

device_namestring

Assigned device name

securityJSON Object

Device security details

Show Sub-Attributes
passcode_complaintboolean

Whether the device passcode is compliant with policy requirements

external_storage_encryptioninteger

External storage encryption status (-1 = not applicable)

storage_encryptionboolean

Whether device storage encryption is enabled

hardware_encryption_capsinteger

Hardware encryption capabilities (-1 = not applicable)

passcode_complaint_profilesboolean

Whether passcode is compliant with profile requirements

device_rootedboolean

Whether the device is rooted or jailbroken

passcode_presentboolean

Whether a passcode is set on the device

udidstring

Unique Device Identifier

summaryJSON Object

Summary counts for profiles, apps, documents, and groups

Show Sub-Attributes
profile_countstring

Number of profiles installed on the device

app_countstring

Number of apps on the device

doc_countstring

Number of documents on the device

group_countstring

Number of groups the device belongs to

osJSON Object

Operating system details

Show Sub-Attributes
platform_typestring

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

build_versionstring

OS build version string

os_versionstring

Operating system version

resource_idlong

Resource identifier

serial_numberstring

Device serial number

is_cloud_backup_enabledboolean

Whether cloud backup is enabled

model_typeinteger

Model type number

model_idstring

Model identifier

total_ram_memoryinteger

Total RAM in megabytes

used_external_spacestring

Used external storage space (GB)

remarksstring

Remarks about the device

unregistered_timeinteger

Unregistered timestamp (-1 = still registered)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Comprehensive device details including hardware, network, security, and OS info

Copied!
  {
    "warranty_number": "SJSU64728372",
    "agent_version_code": "-1",
    "meid": "SM-G935F",
    "cellular_technology": 1,
    "is_dnd_in_effect": false,
    "used_device_space": "12.86491",
    "is_ios_native_app_registered": false,
    "office": "North Plaza,CA",
    "apn_username": "zylker",
    "warranty_expiration_date": 1530057600000,
    "model_name": "hero2ltexx",
    "registered_time": "1540655566627",
    "purchase_order_number": "SR2Ik56779",
    "model": "SM-G935F",
    "purchase_type": "Reseller",
    "available_external_capacity": "20.47",
    "asset_tag": "TestDevice",
    "is_activation_lock_enabled": true,
    "available_device_capacity": "13.200405",
    "available_ram_memory": 983,
    "owned_by": "2",
    "warranty_type": "WithService",
    "product_name": "samsung",
    "agent_type": 1,
    "modem_firmware_version": "10.10.00",
    "is_device_locator_enabled": true,
    "purchase_price": 65000,
    "purchase_date": 1527984000000,
    "device_capacity": "24.81",
    "managed_status": 2,
    "added_time": "1523370360750",
    "network_usage": {
      "outgoing_network_usage": 0,
      "device_id": "9007199254741001",
      "incoming_wifi_usage": 0,
      "outgoing_wifi_usage": 0,
      "incoming_network_usage": 0
    },
    "eas_device_identifier": "QEGJKADSR14D1AEAA4F29FM0IC",
    "sims": [
      {
        "subscriber_carrier_network": "--",
        "iccid": 8991400912981718000,
        "is_roaming": true,
        "sim_id": 9508000000013204,
        "current_mnc": 40,
        "subscriber_mnc": 40,
        "current_carrier_network": "--",
        "resource_id": 9508000000013120,
        "imei": 357327071694307,
        "subscriber_mcc": "in",
        "current_mcc": "in"
      }
    ],
    "description": "Belong to Zylker Inc",
    "is_lost_mode_enabled": false,
    "network": {
      "outgoing_network_usage": 0,
      "device_id": "9007199254741001",
      "incoming_wifi_usage": 0,
      "outgoing_wifi_usage": 0,
      "incoming_network_usage": 0
    },
    "external_capacity": "29.82",
    "device_name": "admin_SM-G935F",
    "security": {
      "passcode_complaint": false,
      "external_storage_encryption": -1,
      "storage_encryption": false,
      "hardware_encryption_caps": -1,
      "passcode_complaint_profiles": true,
      "device_rooted": false,
      "passcode_present": false
    },
    "knox_details": {
      "container_state": "-1",
      "knox_version": "2",
      "container_status": "20004",
      "container_remarks": null,
      "container_last_updated_time": "-1"
    },
    "asset_owner": "Sysadmin",
    "udid": "f8c4071d394ef48e",
    "apn_password": null,
    "summary": {
      "doc_count": "1",
      "group_count": "2",
      "profile_count": "5",
      "app_count": "10"
    },
    "battery_level": 22,
    "is_itunes_account_active": true,
    "os": {
      "platform_type": "android",
      "build_version": "NRD90M",
      "os_version": "8.0.0",
      "resource_id": 9508000000013120,
      "serial_number": "2321bkbkqgidga1"
    },
    "is_cloud_backup_enabled": false,
    "is_supervised": false,
    "model_type": 1,
    "serial_number": "2321bkbkqgidga1",
    "model_id": "9007199254740997",
    "last_cloud_backup_date": "-1",
    "total_ram_memory": 3533,
    "used_external_space": "25.38",
    "remarks": "--",
    "unregistered_time": -1
  }
                
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.