GuidesRecipesAPI ReferenceChangelog
Log In
API Reference

Get Smart Group Membership by Id

Get Smart Group Membership by Id

📋

Required privileges:

  • Read Smart Mobile Device Groups
  • Read Mobile Devices
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

instance id of smart-group

Query Params
integer
Defaults to 0
integer
Defaults to 100
sort
array of strings
Defaults to displayName:asc

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

Fields allowed in the sort: airPlayPassword, appAnalyticsEnabled, assetTag, availableSpaceMb,
batteryLevel, batteryHealth, bluetoothLowEnergyCapable, bluetoothMacAddress, capacityMb,
lostModeEnabledDate, declarativeDeviceManagementEnabled, deviceId, deviceLocatorServiceEnabled,
devicePhoneNumber, diagnosticAndUsageReportingEnabled, displayName, doNotDisturbEnabled,
enrollmentSessionTokenValid, exchangeDeviceId, cloudBackupEnabled, osBuild,
osRapidSecurityResponse, osSupplementalBuildVersion, osVersion, ipAddress, itunesStoreAccountActive,
mobileDeviceId, managementId, languages, lastBackupDate, lastEnrolledDate, lastCloudBackupDate,
lastInventoryUpdateDate, locales, locationServicesForSelfServiceMobileEnabled, lostModeEnabled,
managed, mdmProfileExpirationDate, model, modelIdentifier,
modelNumber, modemFirmwareVersion, preferredVoiceNumber, quotaSize, residentUsers,
serialNumber, sharedIpad, supervised, tethered,
timeZone, udid, usedSpacePercentage, wifiMacAddress,
deviceOwnershipType, building, department, emailAddress,
fullName, userPhoneNumber, position, room,
username, appleCareId, leaseExpirationDate,lifeExpectancyYears,
poDate, poNumber, purchasePrice, purchasedOrLeased,
purchasingAccount, purchasingContact, vendor, warrantyExpirationDate,
activationLockEnabled, blockEncryptionCapable, dataProtection, fileEncryptionCapable,
hardwareEncryptionSupported, jailbreakStatus, passcodeCompliant, passcodeCompliantWithProfile,
passcodeLockGracePeriodEnforcedSeconds, passcodePresent, carrierSettingsVersion,
cellularTechnology, currentCarrierNetwork, currentMobileCountryCode, currentMobileNetworkCode,
dataRoamingEnabled, eid, network, homeMobileCountryCode,
homeMobileNetworkCode, iccid, imei, imei2,
meid, personalHotspotEnabled, voiceRoamingEnabled, roaming, lastLoggedInUsernameSelfService, lastLoggedInUsernameSelfServiceTimestamp,
lastLoggedInUsernameMdm, lastLoggedInUsernameMdmTimestamp

Extension attributes can be sorted by using the format EA+ID where ID is the ID of the extension attribute, for example EA+1!=null

Example: sort=displayName:desc,username:asc

sort
string

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

Fields allowed in the query: airPlayPassword, appAnalyticsEnabled, assetTag, availableSpaceMb,
batteryLevel, bluetoothLowEnergyCapable, bluetoothMacAddress, capacityMb,
declarativeDeviceManagementEnabled, deviceId, deviceLocatorServiceEnabled, devicePhoneNumber,
diagnosticAndUsageReportingEnabled, displayName, doNotDisturbEnabled, exchangeDeviceId,
cloudBackupEnabled, osBuild, osSupplementalBuildVersion, osVersion, osRapidSecurityResponse, ipAddress,
itunesStoreAccountActive, mobileDeviceId, managementId, languages, lastInventoryUpdateDate, locales,
locationServicesForSelfServiceMobileEnabled, lostModeEnabled, managed, model,
modelIdentifier, modelNumber, modemFirmwareVersion, preferredVoiceNumber, quotaSize,
residentUsers, serialNumber, sharedIpad, supervised,
tethered, timeZone, udid, usedSpacePercentage,
wifiMacAddress, building, department, emailAddress,
fullName, userPhoneNumber, position, room,
username, appleCareId, lifeExpectancyYears, poNumber,
purchasePrice, purchasedOrLeased, purchasingAccount, purchasingContact,
vendor, activationLockEnabled, blockEncryptionCapable, dataProtection,
fileEncryptionCapable, passcodeCompliant, passcodeCompliantWithProfile, passcodeLockGracePeriodEnforcedSeconds,
passcodePresent, carrierSettingsVersion, currentCarrierNetwork,
currentMobileCountryCode, currentMobileNetworkCode, dataRoamingEnabled, eid,
network, homeMobileCountryCode, homeMobileNetworkCode, iccid,
imei, imei2, meid, personalHotspotEnabled,
roaming, lastLoggedInUsernameSelfService, lastLoggedInUsernameSelfServiceTimestamp,
lastLoggedInUsernameMdm, lastLoggedInUsernameMdmTimestamp

Extension attributes can be filtered by using the format EA+ID where ID is the ID of the extension attribute, for example EA+1!=null

This param can be combined with paging and sorting.
Example: filter=displayName=="iPad"

Responses

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