mobileDevices

Mobile Devices. Mobile devices syncing mailboxes via ActiveSync, with wipe actions. The mobileDevices entity set lives under /exchange/v1.0/mobileDevices in the Devices & mobile category.

Fact	Value
Path	/exchange/v1.0/mobileDevices
Category	Devices & mobile
Tier	Tier 9, Hybrid and organization
Read role	Device.Read.All (Community)
Write role	Device.ReadWrite.All (Pro)
Backing cmdlets	Get-MobileDevice, Get-MobileDeviceStatistics, Clear-MobileDevice, Remove-MobileDevice

Routes

Method	Path	Synopsis	Role	Plan
GET	/exchange/v1.0/mobileDevices	List mobileDevices entries.	Device.Read	Community
GET	/exchange/v1.0/mobileDevices/{key}	Get a single mobileDevices entry by Identity.	Device.Read	Community
DELETE	/exchange/v1.0/mobileDevices/{key}	DELETE /mobileDevices/{key} - removes the device partnership record (does NOT wipe the device). Use POST /mobileDevices/{key}/clear to trigger a remote wipe before removing if the device is still in use.	Device.ReadWrite	Pro
POST	/exchange/v1.0/mobileDevices/{key}/clear	POST /mobileDevices/{key}/clear - bound action that triggers a remote wipe via Clear-MobileDevice. Destructive: the next time the device contacts EXO it will reset to factory state. Use ?accountOnly=true to clear only the Exchange account (modern devices); ?cancel=true to undo a pending wipe before the device next checks in. Optional body {“notificationEmailAddresses”:[“…”]} sends a confirmation email to the listed addresses after the wipe completes.	Device.ReadWrite	Pro

GET /exchange/v1.0/mobileDevices

List mobileDevices entries.

Backing cmdlet: Get-MobileDevice. Role: Device.Read (Community).

Parameter	In	Type	Required	Description
mailbox	query	string		Optional: scope the list to a single mailbox’s device partnerships (Get-MobileDevice -Mailbox). Accepts any mailbox identifier - UPN / email / alias / GUID / Name. This is the canonical ‘list all devices for one mailbox’ query; not expressible via $filter since it is a parameter-set discriminator, not an OPATH field.
all	query	bool (switch)		Return all results instead of the EXO default of 1000. Maps -ResultSize Unlimited on Get-MobileDevice; prevents silent truncation in large tenants.
restApi	query	bool (switch)		Filter the results to REST API devices only. Maps -RestApi.
universalOutlook	query	bool (switch)		Filter the results to Mail and Calendar (Universal Outlook) devices only. Maps -UniversalOutlook.
activeSync	query	bool (switch)		Filter the results to Exchange ActiveSync devices only. Maps -ActiveSync.
oWAforDevices	query	bool (switch)		Filter the results to Outlook for iOS and Android (OWA for Devices) devices only. Maps -OWAforDevices.

List mobileDevices

Stub auto-generated example for the mobileDevices collection. Backing cmdlet: Get-MobileDevice. Live-verify with ?$top=3&$select=Id,Name and replace the synthetic body before promoting to Tier 1.

GET /exchange/v1.0/mobileDevices?$top=3 HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mobileDevices",
  "value": []
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mobileDevices/{key}

GET /exchange/v1.0/mobileDevices/{key}

Get a single mobileDevices entry by Identity.

Backing cmdlet: Get-MobileDevice. Role: Device.Read (Community).

Get a single mobileDevices entry

Stub auto-generated example for GET /mobileDevices/{key}. Backing cmdlet: Get-MobileDevice with -Identity {key}. Returns the full entity body; 404 if the identity doesn’t resolve.

GET /exchange/v1.0/mobileDevices/{key} HTTP/1.1
Authorization: Bearer {token}

HTTP/1.1 200 OK

{
  "@odata.context": "http://localhost:5043/exchange/v1.0/$metadata#mobileDevices/$entity"
}

Notes: Illustrative example derived from the cmdlet documentation, not a live capture: field names are real, values are placeholders.

Related: GET /exchange/v1.0/mobileDevices

DELETE /exchange/v1.0/mobileDevices/{key}

DELETE /mobileDevices/{key} - removes the device partnership record (does NOT wipe the device). Use POST /mobileDevices/{key}/clear to trigger a remote wipe before removing if the device is still in use.

Backing cmdlet: Remove-MobileDevice. Role: Device.ReadWrite (Pro).

Parameter	In	Type	Required	Description
dryRun	query	bool (switch)

Remove a mobile device partnership

Removes the Exchange ActiveSync device partnership record at the mailbox-scoped device identity via Remove-MobileDevice. This removes only the partnership metadata and does not wipe the device; use POST /mobileDevices/{key}/clear first if the device is still in use.

DELETE /exchange/v1.0/mobileDevices/{key} HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json

HTTP/1.1 204 No Content

Notes: Doc-derived from Wiki + write-param allowlist; not live-captured. Body fields are Wiki-valid; values are illustrative.

Related: GET /exchange/v1.0/mobileDevices

POST /exchange/v1.0/mobileDevices/{key}/clear

POST /mobileDevices/{key}/clear - bound action that triggers a remote wipe via Clear-MobileDevice. Destructive: the next time the device contacts EXO it will reset to factory state. Use ?accountOnly=true to clear only the Exchange account (modern devices); ?cancel=true to undo a pending wipe before the device next checks in. Optional body {“notificationEmailAddresses”:[“…”]} sends a confirmation email to the listed addresses after the wipe completes.

Backing cmdlet: Clear-MobileDevice. Role: Device.ReadWrite (Pro).

Parameter	In	Type	Required	Description
notificationEmailAddresses	body	array
accountOnly	query	bool (switch)
cancel	query	bool (switch)
dryRun	query	bool (switch)

Clear (remote-wipe) a mobile device

Sub-resource of the mobile device at GET /mobileDevices/{key} - triggers a remote wipe via Clear-MobileDevice. Destructive: the next time the device contacts Exchange Online it resets to factory state. Pass an optional body with notificationEmailAddresses to email a confirmation after the wipe; use ?accountOnly=true to clear only the Exchange account or ?cancel=true to undo a pending wipe.

POST /exchange/v1.0/mobileDevices/{key}/clear HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json

{
  "notificationEmailAddresses": [
    "[email protected]"
  ]
}

HTTP/1.1 204 No Content

Notes: Doc-derived from Wiki + write-param allowlist; not live-captured. Body fields are Wiki-valid; values are illustrative.

Related: GET /exchange/v1.0/mobileDevices

?dryRun=true previews of any write stay on Community.