--- updatedAt: 2026-06-15T13:51:20.000Z agentTools: siteIndex: https://developer.jamf.com/llms.txt projectIndex: https://developer.jamf.com/jamf-pro/llms.txt --- # Return paginated Mobile Device Inventory records Return paginated Mobile Device Inventory records > 📋 **Required privilege:** Read Mobile Devices # OpenAPI definition ```json { "openapi": "3.0.1", "info": { "title": "Jamf Pro API", "termsOfService": "https://www.jamf.com/developer-resources/api-license-agreement", "version": "11.32.0" }, "servers": [ { "url": "https://yourServer.jamfcloud.com/api" } ], "x-readme": { "samples-languages": [ "curl", "swift", "ruby", "python" ], "explorer-enabled": false }, "security": [ { "Bearer": [] }, { "ApiClient": [] }, { "BasicAuth": [ "/v1/auth/token" ] } ], "paths": { "/v2/mobile-devices/detail": { "get": { "tags": [ "mobile-devices" ], "summary": "Return paginated Mobile Device Inventory records", "description": "Return paginated Mobile Device Inventory records\n\n> 📋 **Required privilege:** Read Mobile Devices", "parameters": [ { "name": "section", "in": "query", "description": "section of mobile device details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "example": [ "GENERAL" ], "items": { "$ref": "#/components/schemas/MobileDeviceSection" }, "default": [ "GENERAL" ] } }, { "name": "exception-handling", "in": "query", "description": "Controls how the endpoint handles exceptions when processing device data.\n- STRICT (default): Returns a 500 error with details when a device has data processing issues.\n Each problematic device is surfaced one at a time.\n- LENIENT: Returns a 200 response even when devices have processing issues. Problematic sections\n will be null in the response, and all devices (including those with issues) are included.\n Exceptions are logged to the Jamf Pro Server logs.\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "example": "STRICT", "enum": [ "STRICT", "LENIENT" ], "default": "STRICT" } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/page-size" }, { "name": "sort", "in": "query", "description": "Sorting criteria in the format: property:asc/desc. Default sort\nis displayName:asc. Multiple sort criteria are supported and must be separated with\na comma.\n\nFields allowed in the sort: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `batteryHealth`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`lostModeEnabledDate`, `declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`,\n`devicePhoneNumber`, `diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`,\n`enrollmentSessionTokenValid`, `exchangeDeviceId`, `cloudBackupEnabled`, `osBuild`,\n`osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`, `ipAddress`, `itunesStoreAccountActive`,\n`mobileDeviceId`, `managementId`, `languages`, `lastBackupDate`, `lastContactDate`, `lastEnrolledDate`, `lastCloudBackupDate`,\n`lastInventoryUpdateDate`, `locales`, `locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`,\n`managed`, `mdmProfileExpirationDate`, `model`, `modelIdentifier`,\n`modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`, `residentUsers`,\n`serialNumber`, `sharedIpad`, `supervised`, `tethered`,\n`timeZone`, `udid`, `usedSpacePercentage`, `wifiMacAddress`,\n`deviceOwnershipType`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `leaseExpirationDate`,`lifeExpectancyYears`,\n`poDate`, `poNumber`, `purchasePrice`, `purchasedOrLeased`,\n`purchasingAccount`, `purchasingContact`, `vendor`, `warrantyExpirationDate`,\n`activationLockEnabled`, `blockEncryptionCapable`, `dataProtection`, `fileEncryptionCapable`,\n`hardwareEncryptionSupported`, `jailbreakStatus`, `passcodeCompliant`, `passcodeCompliantWithProfile`,\n`passcodeLockGracePeriodEnforcedSeconds`, `passcodePresent`, `carrierSettingsVersion`,\n`cellularTechnology`, `currentCarrierNetwork`, `currentMobileCountryCode`, `currentMobileNetworkCode`,\n`dataRoamingEnabled`, `eid`, `network`, `homeMobileCountryCode`,\n`homeMobileNetworkCode`, `iccid`, `imei`, `imei2`,\n`meid`, `personalHotspotEnabled`, `voiceRoamingEnabled`, `roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`\n\nExample: `sort=displayName:desc,username:asc`\n", "required": false, "style": "form", "explode": true, "schema": { "type": "array", "items": { "type": "string" }, "default": [ "displayName:asc" ] } }, { "name": "filter", "in": "query", "description": "Query in the RSQL format, allowing to filter mobile device collection.\nDefault filter is empty query - returning all results for the requested page.\n\nFields allowed in the query: `airPlayPassword`, `appAnalyticsEnabled`, `assetTag`, `availableSpaceMb`,\n`batteryLevel`, `bluetoothLowEnergyCapable`, `bluetoothMacAddress`, `capacityMb`,\n`declarativeDeviceManagementEnabled`, `deviceId`, `deviceLocatorServiceEnabled`, `devicePhoneNumber`,\n`diagnosticAndUsageReportingEnabled`, `displayName`, `doNotDisturbEnabled`, `exchangeDeviceId`,\n`cloudBackupEnabled`, `osBuild`, `osSupplementalBuildVersion`, `osVersion`, `osRapidSecurityResponse`,\n`ipAddress`, `itunesStoreAccountActive`, `mobileDeviceId`, `managementId`, `languages`, `lastContactDate`, `lastInventoryUpdateDate`, `locales`,\n`locationServicesForSelfServiceMobileEnabled`, `lostModeEnabled`, `managed`, `model`,\n`modelIdentifier`, `modelNumber`, `modemFirmwareVersion`, `preferredVoiceNumber`, `quotaSize`,\n`residentUsers`, `serialNumber`, `sharedIpad`, `supervised`,\n`tethered`, `timeZone`, `udid`, `usedSpacePercentage`,\n`wifiMacAddress`, `building`, `department`, `emailAddress`,\n`fullName`, `userPhoneNumber`, `position`, `room`,\n`username`, `appleCareId`, `lifeExpectancyYears`, `poNumber`,\n`purchasePrice`, `purchasedOrLeased`, `purchasingAccount`, `purchasingContact`,\n`vendor`, `activationLockEnabled`, `awaitingConfiguration`, `blockEncryptionCapable`, `dataProtection`,\n`fileEncryptionCapable`, `lockdownModeEnabled`, `passcodeCompliant`, `passcodeCompliantWithProfile`, `passcodeLockGracePeriodEnforcedSeconds`,\n`passcodePresent`, `returnToServiceEnabled`, `carrierSettingsVersion`, `currentCarrierNetwork`,\n`currentMobileCountryCode`, `currentMobileNetworkCode`, `dataRoamingEnabled`, `eid`,\n`network`, `homeMobileCountryCode`, `homeMobileNetworkCode`, `iccid`,\n`imei`, `imei2`, `meid`, `personalHotspotEnabled`,\n`roaming`, `lastLoggedInUsernameSelfService`, `lastLoggedInUsernameSelfServiceTimestamp`, `lastLoggedInUsernameMdm`, `lastLoggedInUsernameMdmTimestamp`,\n`groupId`, `groupName`\n\nThis param can be combined with paging and sorting.\nExample: `filter=displayName==\"iPad\"`\n", "required": false, "style": "form", "explode": true, "schema": { "type": "string", "default": "" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MobileDeviceInventorySearchResults" } } } } }, "x-required-privileges": [ "Read Mobile Devices" ] } } }, "components": { "schemas": { "EnrollmentMethodPrestage": { "type": "object", "properties": { "mobileDevicePrestageId": { "type": "string", "example": "5" }, "profileName": { "type": "string", "example": "All Mobiles" } } }, "MobileDeviceApplicationInventoryDetail": { "type": "object", "properties": { "identifier": { "type": "string", "example": "com.apple.airport.mobileairportutility" }, "name": { "type": "string", "example": "AirPort Utility" }, "version": { "type": "string", "example": "135.24" }, "shortVersion": { "type": "string", "example": "7.0" }, "managementStatus": { "type": "string", "example": "Managed" }, "validationStatus": { "type": "boolean", "example": true }, "bundleSize": { "type": "string", "example": "1024" }, "dynamicSize": { "type": "string", "example": "1423" }, "appClip": { "type": "boolean", "example": false } } }, "MobileDeviceCertificate": { "type": "object", "properties": { "commonName": { "type": "string", "example": "3B259E4B-FAD5-4860-B1DD-336ADA786EBA" }, "identity": { "type": "boolean", "example": false }, "expirationDate": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" } } }, "MobileDeviceEbookInventoryDetail": { "type": "object", "properties": { "author": { "type": "string", "example": "Homer J Simpson" }, "title": { "type": "string", "example": "The Odyssey" }, "version": { "type": "string", "example": "0.1" }, "kind": { "type": "string", "example": "PDF" }, "managementState": { "type": "string", "example": "Managed" } } }, "MobileDeviceExtensionAttribute": { "type": "object", "properties": { "id": { "type": "string", "readOnly": true, "example": "1" }, "name": { "type": "string", "example": "Example EA" }, "type": { "type": "string", "example": "STRING", "enum": [ "STRING", "INTEGER", "DATE" ] }, "value": { "type": "array", "items": { "type": "string", "example": "EA Value" } }, "extensionAttributeCollectionAllowed": { "type": "boolean", "example": false }, "inventoryDisplay": { "type": "string", "example": "General" } } }, "MobileDeviceGeneral": { "type": "object", "properties": { "udid": { "type": "string", "example": "0dad565fb40b010a9e490440188063a378721069" }, "displayName": { "type": "string", "example": "Banezicron" }, "assetTag": { "type": "string", "example": "8675309" }, "siteId": { "type": "string", "example": "-1" }, "lastInventoryUpdateDate": { "type": "string", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "lastContactDate": { "type": "string", "description": "The date and time of the most recent device contact via MDM or DDM channels.", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "osVersion": { "type": "string", "example": "11.4" }, "osRapidSecurityResponse": { "type": "string", "example": "(a)" }, "osBuild": { "type": "string", "example": "15F79" }, "osSupplementalBuildVersion": { "type": "string", "example": "22A103310o" }, "softwareUpdateDeviceId": { "type": "string", "example": "J132AP" }, "ipAddress": { "type": "string", "example": "10.0.0.1" }, "managed": { "type": "boolean", "example": true }, "supervised": { "type": "boolean", "example": true }, "deviceOwnershipType": { "type": "string", "description": "The enrollment method used for the device. **Note:** The `PersonalDeviceProfile` enrollment method was removed as of 11.25.\n", "example": "Institutional", "enum": [ "Institutional", "UserEnrollment", "AccountDrivenUserEnrollment", "AccountDrivenDeviceEnrollment" ] }, "appleEnrollmentType": { "type": "string", "description": "The enrollment type reported by Apple.", "example": "supervised", "enum": [ "none", "supervised", "device", "user", "unknown" ] }, "awaitingConfiguration": { "type": "boolean", "description": "Whether the device is awaiting configuration.", "example": false }, "enrollmentMethodPrestage": { "$ref": "#/components/schemas/EnrollmentMethodPrestage" }, "enrollmentSessionTokenValid": { "type": "boolean", "example": false }, "lastEnrolledDate": { "type": "string", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "mdmProfileExpirationDate": { "type": "string", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "timeZone": { "type": "string", "description": "IANA time zone database name", "example": "Europe/Warsaw" }, "declarativeDeviceManagementEnabled": { "type": "boolean", "example": true }, "managementId": { "type": "string", "example": "9932fad3-29e9-4b71-bc7c-77dcefce819d" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceExtensionAttribute" } }, "lastLoggedInUsernameSelfService": { "type": "string", "nullable": true, "example": "admin" }, "lastLoggedInUsernameSelfServiceTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2018-10-31T18:04:13Z" }, "lastLoggedInUsernameMdm": { "type": "string", "nullable": true, "example": "admin" }, "lastLoggedInUsernameMdmTimestamp": { "type": "string", "format": "date-time", "nullable": true, "example": "2018-10-31T18:04:13Z" } } }, "MobileDeviceHardware": { "type": "object", "properties": { "capacityMb": { "type": "integer", "example": 100 }, "availableSpaceMb": { "type": "integer", "example": 30 }, "usedSpacePercentage": { "type": "integer", "example": 70 }, "batteryLevel": { "type": "integer", "example": 60 }, "batteryHealth": { "type": "string", "description": "- NON_GENUINE: The battery isn’t a genuine Apple battery.\n- NORMAL: The battery is operating normally.\n- SERVICE_RECOMMENDED: The system recommends battery service.\n- UNKNOWN: The system couldn’t determine battery health information.\n- UNSUPPORTED: The device doesn’t support battery health reporting.\n", "enum": [ "NON_GENUINE", "NORMAL", "SERVICE_RECOMMENDED", "UNKNOWN", "UNSUPPORTED" ], "default": "UNKNOWN" }, "serialNumber": { "type": "string", "example": "5c28fdae" }, "wifiMacAddress": { "type": "string", "example": "ee:00:7c:f0:e5:ff" }, "bluetoothMacAddress": { "type": "string", "example": "ee:00:7c:f0:e5:aa" }, "modemFirmwareVersion": { "type": "string", "example": "iPad7,11" }, "model": { "type": "string", "example": "iPad 7th Generation (Wi-Fi)" }, "modelIdentifier": { "type": "string", "example": "iPad7,11" }, "modelNumber": { "type": "string", "example": "MW742LL" }, "bluetoothLowEnergyCapable": { "type": "boolean", "example": false }, "deviceId": { "type": "string", "example": "c6a49c6d-8c09-4d71-a37d-2f6a9dfbb69b" }, "systemHealth": { "$ref": "#/components/schemas/MobileDeviceSystemHealth" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceExtensionAttribute" } } } }, "MobileDeviceInventory": { "required": [ "deviceType" ], "type": "object", "properties": { "mobileDeviceId": { "minLength": 1, "type": "string", "readOnly": true, "example": "1" }, "deviceType": { "type": "string", "description": "Based on the value of this type either ios, appleTv, watch or visionOS objects will be populated.", "example": "iOS" }, "hardware": { "$ref": "#/components/schemas/MobileDeviceHardware" }, "userAndLocation": { "$ref": "#/components/schemas/MobileDeviceUserAndLocation" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceApplicationInventoryDetail" } }, "certificates": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceCertificate" } }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceProfile" } }, "groups": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceInventoryGroup" } }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceExtensionAttribute" } } } }, "MobileDeviceInventoryGroup": { "type": "object", "properties": { "groupId": { "type": "string", "example": "1" }, "groupName": { "minLength": 1, "type": "string", "example": "Test Group" }, "groupDescription": { "minLength": 0, "type": "string", "example": "Test Group Description" }, "smart": { "type": "boolean", "example": false } } }, "MobileDeviceInventorySearchResults": { "type": "object", "properties": { "totalCount": { "type": "integer", "nullable": false, "example": 2 }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceResponse" } } } }, "MobileDeviceIosGeneral": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceGeneral" }, { "type": "object", "properties": { "sharedIpad": { "type": "boolean", "example": false }, "diagnosticAndUsageReportingEnabled": { "type": "boolean", "example": false }, "appAnalyticsEnabled": { "type": "boolean", "example": false }, "residentUsers": { "type": "integer", "example": 0 }, "quotaSize": { "type": "integer", "example": 1024 }, "temporarySessionOnly": { "type": "boolean", "example": false }, "temporarySessionTimeout": { "type": "integer", "example": 30 }, "userSessionTimeout": { "type": "integer", "example": 30 }, "syncedToComputer": { "type": "integer", "example": 30 }, "maximumSharediPadUsersStored": { "type": "integer", "example": 16 }, "lastBackupDate": { "type": "string", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "deviceLocatorServiceEnabled": { "type": "boolean", "example": false }, "doNotDisturbEnabled": { "type": "boolean", "example": false }, "cloudBackupEnabled": { "type": "boolean", "example": false }, "lastCloudBackupDate": { "type": "string", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "locationServicesForSelfServiceMobileEnabled": { "type": "boolean", "example": false }, "itunesStoreAccountActive": { "type": "boolean", "example": false }, "exchangeDeviceId": { "type": "string", "example": "eas-1" }, "tethered": { "type": "boolean", "example": false }, "returnToServiceEnabled": { "type": "boolean", "description": "Whether Return to Service is enabled.", "example": false } } } ] }, "MobileDeviceIosInventory": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceInventory" }, { "type": "object", "properties": { "general": { "$ref": "#/components/schemas/MobileDeviceIosGeneral" }, "security": { "$ref": "#/components/schemas/MobileDeviceSecurity" }, "ebooks": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceEbookInventoryDetail" } }, "network": { "$ref": "#/components/schemas/MobileDeviceNetwork" }, "serviceSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceServiceSubscriptions" } }, "provisioningProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceProvisioningProfiles" } }, "sharedUsers": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceSharedUser" } }, "purchasing": { "$ref": "#/components/schemas/MobileDevicePurchasing" }, "userProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceUserProfile" } } } } ] }, "MobileDeviceLostModeLocation": { "type": "object", "properties": { "lastLocationUpdate": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" }, "lostModeLocationHorizontalAccuracyMeters": { "type": "number", "example": 7 }, "lostModeLocationVerticalAccuracyMeters": { "type": "number", "example": 5 }, "lostModeLocationAltitudeMeters": { "type": "number", "example": 7.9 }, "lostModeLocationSpeedMetersPerSecond": { "type": "number", "example": 10 }, "lostModeLocationCourseDegrees": { "type": "number", "example": 15 }, "lostModeLocationTimestamp": { "type": "string", "example": "2023-04-21 12:30:00 UTC" } } }, "MobileDeviceNetwork": { "type": "object", "properties": { "cellularTechnology": { "type": "string", "example": "Unknown" }, "voiceRoamingEnabled": { "type": "boolean", "example": false }, "imei": { "type": "string", "example": "59 105109 176278 3" }, "iccid": { "type": "string", "example": "8991101200003204514" }, "meid": { "type": "string", "example": "15302309236898" }, "eid": { "type": "string", "description": "EID or \"embedded identity document\" is a number associated with the eSIM on a device", "readOnly": true, "example": "12547444452496388545569920380795" }, "carrierSettingsVersion": { "type": "string", "example": "33.1" }, "currentCarrierNetwork": { "type": "string", "example": "Verizon Wireless" }, "currentMobileCountryCode": { "type": "string", "example": "311" }, "currentMobileNetworkCode": { "type": "string", "example": "480" }, "homeCarrierNetwork": { "type": "string", "example": "Verizon" }, "homeMobileCountryCode": { "type": "string", "example": "US" }, "homeMobileNetworkCode": { "type": "string", "example": "480" }, "dataRoamingEnabled": { "type": "boolean", "example": true }, "roaming": { "type": "boolean", "example": false }, "personalHotspotEnabled": { "type": "boolean", "example": false }, "phoneNumber": { "type": "string", "example": "555-555-5555 ext 5" }, "preferredVoiceNumber": { "type": "string", "example": "555-555-5555" } }, "description": "This section only avaiable for Ios type." }, "MobileDeviceProfile": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Test WiFi" }, "version": { "type": "string", "example": "1" }, "uuid": { "type": "string", "example": "D29DD9FB-0D5B-422F-A3A2-ABBC5848E949" }, "identifier": { "type": "string", "example": "ac2-server4.D0EFAC2D-326C-4BB6-87E6-2BCB88490AAA" }, "removable": { "type": "boolean", "example": true }, "lastInstalled": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" } } }, "MobileDeviceProvisioningProfiles": { "type": "object", "properties": { "displayName": { "type": "string", "example": "jamfnation" }, "uuid": { "type": "string", "example": "89AF33FC-123C-1231-AEFD-9C3ED123AFCC" }, "expirationDate": { "type": "string", "format": "date-time", "example": "2018-10-24T21:57:37Z" } } }, "MobileDevicePurchasing": { "type": "object", "properties": { "purchased": { "type": "boolean", "example": true }, "leased": { "type": "boolean", "example": false }, "poNumber": { "type": "string", "example": "8675309" }, "vendor": { "type": "string", "example": "Apple" }, "appleCareId": { "type": "string", "example": "9546567.0" }, "purchasePrice": { "type": "string", "example": "$399" }, "purchasingAccount": { "type": "string", "example": "IT Budget" }, "poDate": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" }, "warrantyExpiresDate": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" }, "leaseExpiresDate": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" }, "lifeExpectancy": { "type": "integer", "example": 7 }, "purchasingContact": { "type": "string", "example": "Nick in IT" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceExtensionAttribute" } } } }, "MobileDeviceResponse": { "type": "object", "discriminator": { "propertyName": "deviceType", "mapping": { "iOS": "#/components/schemas/MobileDeviceIosInventory", "tvOS": "#/components/schemas/MobileDeviceTvOsInventory", "watchOS": "#/components/schemas/MobileDeviceWatchOsInventory", "visionOS": "#/components/schemas/MobileDeviceVisionOsInventory" } }, "oneOf": [ { "$ref": "#/components/schemas/MobileDeviceIosInventory" }, { "$ref": "#/components/schemas/MobileDeviceTvOsInventory" }, { "$ref": "#/components/schemas/MobileDeviceWatchOsInventory" }, { "$ref": "#/components/schemas/MobileDeviceVisionOsInventory" } ] }, "MobileDeviceSection": { "type": "string", "example": "GENERAL", "enum": [ "GENERAL", "HARDWARE", "USER_AND_LOCATION", "PURCHASING", "SECURITY", "APPLICATIONS", "EBOOKS", "NETWORK", "SERVICE_SUBSCRIPTIONS", "CERTIFICATES", "PROFILES", "USER_PROFILES", "PROVISIONING_PROFILES", "SHARED_USERS", "GROUPS", "EXTENSION_ATTRIBUTES" ] }, "MobileDeviceSecurity": { "type": "object", "properties": { "dataProtected": { "type": "boolean", "example": false }, "blockLevelEncryptionCapable": { "type": "boolean", "example": true }, "fileLevelEncryptionCapable": { "type": "boolean", "example": true }, "passcodePresent": { "type": "boolean", "example": false }, "passcodeCompliant": { "type": "boolean", "example": true }, "passcodeCompliantWithProfile": { "type": "boolean", "example": true }, "hardwareEncryption": { "type": "integer", "example": 3 }, "activationLockEnabled": { "type": "boolean", "example": false }, "jailBreakDetected": { "type": "boolean", "example": false }, "attestationStatus": { "type": "string", "readOnly": true, "example": "SUCCESS", "enum": [ "PENDING", "SUCCESS", "CERTIFICATE_INVALID", "DEVICE_PROPERTIES_MISMATCH", "MDA_UNSUPPORTED_DUE_TO_HARDWARE", "MDA_UNSUPPORTED_DUE_TO_SOFTWARE" ] }, "lastAttestationAttemptDate": { "type": "string", "format": "date-time", "readOnly": true, "example": "2019-02-04T21:09:31.661Z" }, "lastSuccessfulAttestationDate": { "type": "string", "format": "date-time", "readOnly": true, "example": "2019-02-04T21:09:31.661Z" }, "passcodeLockGracePeriodEnforcedSeconds": { "type": "integer", "example": 3 }, "personalDeviceProfileCurrent": { "type": "boolean", "description": "**Deprecated as of 11.25.** This field always returns false\n", "readOnly": true, "deprecated": true, "default": false }, "lostModeEnabled": { "type": "boolean", "example": false }, "lostModePersistent": { "type": "boolean", "example": false }, "lostModeMessage": { "type": "string", "example": "Lost phone" }, "lostModePhoneNumber": { "type": "string", "example": "555-555-5555" }, "lostModeFootnote": { "type": "string", "example": "Note" }, "lostModeLocation": { "$ref": "#/components/schemas/MobileDeviceLostModeLocation" }, "bootstrapTokenEscrowed": { "type": "string", "description": "Indicates the bootstrap token escrow status for the device", "example": "NOT_SUPPORTED", "enum": [ "ESCROWED", "NOT_ESCROWED", "NOT_SUPPORTED" ] }, "lockdownModeEnabled": { "type": "boolean", "description": "Whether Lockdown Mode is enabled.", "example": false } }, "description": "This section only available for Ios type." }, "MobileDeviceServiceSubscriptions": { "type": "object", "properties": { "carrierSettingsVersion": { "type": "string", "example": "47.1" }, "currentCarrierNetwork": { "type": "string", "example": "T-Mobile Wi-Fi" }, "currentMobileCountryCode": { "type": "string", "example": "310" }, "currentMobileNetworkCode": { "type": "string", "example": "260" }, "subscriberCarrierNetwork": { "type": "string", "example": "T-Mobile Wi-Fi" }, "eid": { "type": "string", "example": "89049032007008882600085727376656" }, "iccid": { "type": "string", "example": "8901 2605 7071 8002 130" }, "imei": { "type": "string", "example": "35 882334 083223 0" }, "dataPreferred": { "type": "boolean", "example": true }, "roaming": { "type": "boolean", "example": true }, "voicePreferred": { "type": "boolean", "example": true }, "label": { "type": "string", "example": "Primary" }, "labelId": { "type": "string", "description": "The unique identifier for this subscription.", "example": "D1F4AEC5-2FCD-4A6D-A09E-A940F60F856B" }, "meid": { "type": "string", "example": "35882334083223" }, "phoneNumber": { "type": "string", "example": "+15128145868" }, "slot": { "type": "string", "description": "The description of the slot that contains the SIM representing this subscription.", "example": "CTSubscriptionSlotOne" } } }, "MobileDeviceSharedUser": { "type": "object", "properties": { "managedAppleId": { "type": "string", "example": "astark@jamf.edu" }, "loggedIn": { "type": "boolean", "example": true }, "dataToSync": { "type": "boolean", "example": true } } }, "MobileDeviceSystemHealth": { "type": "object", "properties": { "baseband": { "maxLength": 255, "type": "string", "example": "ok" }, "camera": { "maxLength": 255, "type": "string", "example": "ok" }, "display": { "maxLength": 255, "type": "string", "example": "ok" }, "faceId": { "maxLength": 255, "type": "string", "example": "ok" }, "touchId": { "maxLength": 255, "type": "string", "example": "ok" }, "nfc": { "maxLength": 255, "type": "string", "example": "ok" }, "ultraWideband": { "maxLength": 255, "type": "string", "example": "ok" } }, "description": "System health status for device components. Reported for iOS devices." }, "MobileDeviceTvOsGeneral": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceGeneral" }, { "type": "object", "properties": { "airPlayPassword": { "type": "string", "example": "1234" }, "locales": { "type": "string", "example": "null" }, "languages": { "type": "string", "example": "english" } } } ] }, "MobileDeviceTvOsInventory": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceInventory" }, { "type": "object", "properties": { "general": { "$ref": "#/components/schemas/MobileDeviceTvOsGeneral" }, "purchasing": { "$ref": "#/components/schemas/MobileDevicePurchasing" }, "userProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceUserProfile" } } } } ] }, "MobileDeviceUserAndLocation": { "type": "object", "properties": { "username": { "type": "string", "example": "admin" }, "realName": { "type": "string", "example": "IT Bob" }, "emailAddress": { "type": "string", "example": "ITBob@jamf.com" }, "position": { "type": "string", "example": "IT Team Lead" }, "phoneNumber": { "type": "string", "example": "555-555-5555" }, "departmentId": { "type": "string", "example": "1" }, "buildingId": { "type": "string", "example": "1" }, "room": { "type": "string", "example": "room" }, "building": { "type": "string", "example": "Building 1" }, "department": { "type": "string", "example": "Department 1" }, "extensionAttributes": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceExtensionAttribute" } } } }, "MobileDeviceUserProfile": { "type": "object", "properties": { "displayName": { "type": "string", "example": "Test WiFi" }, "version": { "type": "string", "example": "1" }, "uuid": { "type": "string", "example": "D29DD9FB-0D5B-422F-A3A2-ABBC5848E949" }, "identifier": { "type": "string", "example": "ac2-server4.D0EFAC2D-326C-4BB6-87E6-2BCB88490AAA" }, "removable": { "type": "boolean", "example": true }, "lastInstalled": { "type": "string", "format": "date-time", "example": "2019-02-04T21:09:31.661Z" }, "username": { "type": "string", "example": "admin" } } }, "MobileDeviceVisionOsGeneral": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceGeneral" }, { "type": "object", "properties": { "diagnosticAndUsageReportingEnabled": { "type": "boolean", "example": false }, "appAnalyticsEnabled": { "type": "boolean", "example": false }, "deviceLocatorServiceEnabled": { "type": "boolean", "example": false }, "doNotDisturbEnabled": { "type": "boolean", "example": false }, "cloudBackupEnabled": { "type": "boolean", "example": false }, "lastCloudBackupDate": { "type": "string", "format": "date-time", "nullable": true, "example": "2022-10-17T11:48:56.307Z" }, "itunesStoreAccountActive": { "type": "boolean", "example": false } } } ] }, "MobileDeviceVisionOsInventory": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceInventory" }, { "type": "object", "properties": { "general": { "$ref": "#/components/schemas/MobileDeviceVisionOsGeneral" }, "security": { "$ref": "#/components/schemas/MobileDeviceSecurity" }, "network": { "$ref": "#/components/schemas/MobileDeviceNetwork" }, "provisioningProfiles": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/MobileDeviceProvisioningProfiles" } }, "purchasing": { "$ref": "#/components/schemas/MobileDevicePurchasing" } } } ] }, "MobileDeviceWatchOsGeneral": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceGeneral" }, { "type": "object", "properties": { "diagnosticAndUsageReportingEnabled": { "type": "boolean", "example": false }, "appAnalyticsEnabled": { "type": "boolean", "example": false }, "deviceLocatorServiceEnabled": { "type": "boolean", "example": false }, "doNotDisturbEnabled": { "type": "boolean", "example": false }, "lastCloudBackupDate": { "type": "string", "format": "date-time", "example": "2022-10-17T11:48:56.307Z" }, "itunesStoreAccountActive": { "type": "boolean", "example": false } } } ] }, "MobileDeviceWatchOsInventory": { "allOf": [ { "$ref": "#/components/schemas/MobileDeviceInventory" }, { "type": "object", "properties": { "general": { "$ref": "#/components/schemas/MobileDeviceWatchOsGeneral" }, "security": { "$ref": "#/components/schemas/MobileDeviceSecurity" }, "provisioningProfiles": { "type": "array", "items": { "$ref": "#/components/schemas/MobileDeviceProvisioningProfiles" } } } } ] } }, "parameters": { "page": { "name": "page", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 0 } }, "page-size": { "name": "page-size", "in": "query", "required": false, "style": "form", "explode": true, "schema": { "type": "integer", "default": 100 } } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "BasicAuth": { "type": "http", "description": "Basic auth is used only for obtaining bearer tokens from the /v1/auth/token endpoint", "scheme": "basic" }, "ApiClient": { "type": "oauth2", "description": "Jamf Pro API Roles and Clients provide a client ID and secret for obtaining access tokens using the OAuth2 client_credentials grant type", "flows": { "clientCredentials": { "tokenUrl": "/api/v1/oauth/token", "scopes": {} } } } } } } ```