GET
/
organizations
/
{orgId}
/
devices
curl --request GET \
  --url https://managexrapi.com/organizations/{orgId}/devices \
  --header 'Authorization: Basic <encoded-value>'
[
  {
    "serial": "2G0YC1ZF630NZA",
    "name": "Oculus Quest 2",
    "mac": "0816D76C3AE5",
    "model": "Quest 2",
    "manufacturer": "Oculus",
    "notes": "with Phil P",
    "batteryLevel": 81,
    "online": false,
    "osVersion": 10,
    "outOfDate": true,
    "registerDate": "Thu, 08 Jun 2023 21:16:39 GMT",
    "updating": false,
    "factoryResetStatus": null,
    "firmwareVersion": "65.0.0.546.341",
    "configuration": {
      "name": "Quality Assurance",
      "id": "SpGcLo99xqMkj9dyNvBd"
    },
    "tags": [],
    "tutorialModeEnabled": false,
    "kioskModeOverride": false,
    "lastSync": "Mon, 24 Jun 2024 19:33:21 GMT",
    "ram": {
      "available": 4276592640,
      "total": 8151437312
    },
    "location": {
      "city": "Galt",
      "region": "California",
      "country": "United States",
      "continent": "North America",
      "timeZone": "America/Los_Angeles",
      "latitude": 37,
      "longitude": -122
    },
    "connectedWifiNetwork": {
      "ssid": "Comcast"
    },
    "storage": {
      "available": 235923423232
    }
  },
  {
    "serial": "PA7950RGGC06043",
    "name": "Carolina",
    "mac": "0816D56C3AE4",
    "model": "Quest 2",
    "manufacturer": "Oculus",
    "notes": null,
    "batteryLevel": 81,
    "online": false,
    "osVersion": 10,
    "outOfDate": true,
    "registerDate": "Thu, 08 Jun 2023 21:16:39 GMT",
    "updating": false,
    "factoryResetStatus": "QUEUED",
    "firmwareVersion": "4.0.7",
    "configuration": {
      "name": "Customer Success",
      "id": "SpGcLo99xqMkj9dyNvBd"
    },
    "tags": null,
    "tutorialModeEnabled": false,
    "kioskModeOverride": false,
    "lastSync": "Mon, 24 Jun 2024 19:33:21 GMT",
    "ram": {
      "available": 4276592640,
      "total": 8151437312
    },
    "location": {
      "city": "Ílhavo",
      "region": "Aveiro",
      "country": "Portugal",
      "continent": "Europe",
      "timeZone": "Europe/Lisbon",
      "latitude": 38,
      "longitude": 9
    },
    "connectedWifiNetwork": {
      "ssid": "Carol"
    },
    "storage": {
      "available": 51294728192
    }
  }
]

Authorizations

​
Authorization
string
header
required

API key based authentication where <encoded-value> is the Base64 encoding of API_KEY_ID:API_KEY_SECRET

  • Username: The API Key ID.
  • Password: The API Key Secret.

Path Parameters

​
orgId
string
required

The ID of the organization. Locate the orgId under Organization Settings > API Keys.

Query Parameters

​
names
string

Query by device name. Allows partial matching. Separate multiple name parameters by comma.

​
serials
string

Query by device serial. Allows partial matching. Separate multiple serial parameters by comma.

​
configurations
string

Query by configuration unique identifier. Separate multiple configuration id parameters by comma.

​
tags
string

Query by tag unique identifier. Separate multiple tag id parameters by comma.

​
models
string

Query by model name. Separate multiple model parameters by comma.

​
manufacturers
string

Query by manufacturer name. Separate multiple manufacturer parameters by comma.

​
firmwareVersions
string

Query by firmware version. Separate multiple firmware version parameters by comma.

​
filters
enum<string>

Query by filter.

Available options:
online,
offline,
upToDate,
outOfDate,
updateError,
updating,
paused,
lowBattery,
activeToday,
activeWeek,
activeMonth,
activeOther,
factoryResetPending,
factoryReset

Response

200 - application/json
A list of devices
​
serial
string

The serial number of the device. Also serves as the ID on ManageXR.

Example:

"2G0YC1ZF630NZA"

​
name
string

The name given to the device on ManageXR

Example:

"Device_0024"

​
mac
string

Device MAC address

Example:

"CE:AF:07:47:E0:AE"

​
model
string

Device model

Example:

"Quest 3"

​
manufacturer
string

Device manufacturer. Note, Meta devices report as Oculus

Example:

"Oculus"

​
notes
string

The notes given to a device on ManageXR

Example:

"With Taylor L"

​
batteryLevel
number

The battery level of the device

Example:

34

​
online
boolean

True if the device is online

Example:

true

​
osVersion
string

The Android operating system version

Example:

12

​
outOfDate
boolean

True if device is not compliant with its configuration on ManageXR

Example:

false

​
pauseUpdates
boolean

True if configuration updates are paused for device. Pausing configuration updates stops a device from syncing with its latest Configuration. User-initiated changes to Configurations and ManageXR-initiated updates to the ManageXR Admin App and Home Screen will not propagate to devices with updates paused.

Example:

false

​
registerDate
string

Date the device was registered on ManageXR

Example:

"Tue, 27 Feb 2024 07:28:03 GMT"

​
updating
boolean

True if the device is currently downloading content or firmware

Example:

false

​
factoryResetStatus
enum<string>

This status is set when an admin sends a factory reset command to a device. Null if no factory reset command has been sent.

Available options:
QUEUED,
COMPLETE
Example:

null

​
firmwareVersion
string

Device firmware version

Example:

"65.0.0.546.341"

​
configuration
object

The configuration applied to the device on ManageXR

Example:
{
  "name": "Test Configuration",
  "id": "OZ04csIYkA0EArkeu1vX"
}
​
tags
object[]

The tags applied to the device on ManageXR. Null if device has no tags.

​
tutorialModeEnabled
boolean

True if device is in Tutorial Mode

Example:

false

​
kioskModeOverride
boolean

True if device has Kiosk Mode/ManageXR Home Screen disabled. When true, the device is not locked into the ManageXR Home Screen or Kiosk App and users have full access to the native system menus. Learn more

Example:

false

​
lastSync
string

The last time the device checked in with ManageXR. Online devices check in every 15 minutes.

Example:

"Tue, 18 Jun 2024 21:46:34 GMT"

​
ram
object

Device RAM in bytes

Example:
{
  "available": 3704000512,
  "total": 8108634112
}
​
location
object

Device location as determined by its IP address and provided by ipstack.com

Example:
{
  "city": "San Francisco",
  "region": "California",
  "country": "United States",
  "continent": "North America",
  "timeZone": "America/Los_Angeles",
  "latitude": 37,
  "longitude": -122
}
​
connectedWifiNetwork
object

Information about the last connected wifi network

Example:
{ "ssid": "TheElectricCity" }
​
storage
object

The available storage on the device in bytes

Example:
{ "available": 107079929856 }