Return paginated Computer Inventory records

Return paginated Computer Inventory records

Required Permissions: devices:read

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
section
array of objects
Defaults to GENERAL

section of computer details, if not specified, General section data is returned. Multiple section parameters are supported, e.g. section=GENERAL&section=HARDWARE

section
integer
Defaults to 0
integer
Defaults to 100
sort
array of strings
Defaults to general.name:asc

Sorting criteria in the format: property:asc/desc. Default sort
is general.name:asc. Multiple sort criteria are supported and must be separated with
a comma.

Fields allowed in the sort: general.name, udid, id, general.assetTag,
general.jamfBinaryVersion, general.lastContactTime, general.lastEnrolledDate, general.lastCloudBackupDate,
general.reportDate,
general.mdmCertificateExpiration, general.platform, general.lastLoggedInUsernameSelfService, general.lastLoggedInUsernameSelfServiceTimestamp,
general.lastLoggedInUsernameBinary, general.lastLoggedInUsernameBinaryTimestamp,
general.lastLoggedInUsernameMdm, general.lastLoggedInUsernameMdmTimestamp,
hardware.make, hardware.model,
operatingSystem.build, operatingSystem.supplementalBuildVersion, operatingSystem.rapidSecurityResponse, operatingSystem.name, operatingSystem.version,
userAndLocation.realname,
purchasing.lifeExpectancy, purchasing.warrantyDate

Example: sort=udid:desc,general.name:asc.

sort
string

Query in the RSQL format, allowing to filter computer inventory collection.
Default filter is empty query - returning all results for the requested page.

Fields allowed in the query: general.name, udid, id, general.assetTag, general.barcode1, general.barcode2,
general.enrolledViaAutomatedDeviceEnrollment, general.lastIpAddress, general.itunesStoreAccountActive,
general.jamfBinaryVersion, general.lastContactTime, general.lastEnrolledDate, general.lastCloudBackupDate,
general.reportDate, general.lastReportedIp, general.lastReportedIpV4, general.lastReportedIpV6, general.managementId, general.remoteManagement.managed,
general.mdmCapable.capable, general.mdmCertificateExpiration, general.platform, general.supervised, general.userApprovedMdm, general.declarativeDeviceManagementEnabled,
general.lastLoggedInUsernameSelfService, general.lastLoggedInUsernameSelfServiceTimestamp,
general.lastLoggedInUsernameBinary, general.lastLoggedInUsernameBinaryTimestamp,
general.lastLoggedInUsernameMdm, general.lastLoggedInUsernameMdmTimestamp,
hardware.bleCapable, hardware.macAddress, hardware.make, hardware.model, hardware.modelIdentifier, hardware.serialNumber,
hardware.supportsIosAppInstalls,hardware.appleSilicon, operatingSystem.activeDirectoryStatus, operatingSystem.fileVault2Status,
operatingSystem.build, operatingSystem.supplementalBuildVersion, operatingSystem.rapidSecurityResponse, operatingSystem.name, operatingSystem.version, security.activationLockEnabled,
security.recoveryLockEnabled,security.firewallEnabled,userAndLocation.buildingId, userAndLocation.departmentId, userAndLocation.email, userAndLocation.realname,
userAndLocation.phone, userAndLocation.position,userAndLocation.room, userAndLocation.username, diskEncryption.fileVault2Enabled,
purchasing.appleCareId, purchasing.lifeExpectancy, purchasing.purchased, purchasing.leased, purchasing.vendor, purchasing.warrantyDate,

This param can be combined with paging and sorting.
Example: filter=general.name=="Orchard"

Headers
uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The tenant UUID identifier. Send it to address tenant scope. This API is also published at environment scope — send that scope's header instead. Send exactly one scope header per request.

uuid
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

The environment UUID identifier. Send it to address environment scope. This API is also published at tenant scope — send that scope's header instead. Send exactly one scope header per request.

Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json