List Devices

curl --request GET \
  --url https://managexrapi.com/organizations/{orgId}/devices \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "12345678901234",
    "serial": "12345678901234",
    "name": "Training Room 1",
    "mac": "CE:AF:07:47:E0:AE",
    "model": "Quest 2",
    "manufacturer": "Meta",
    "notes": "Mounted in Room 5",
    "batteryLevel": 87,
    "batteryIsCharging": true,
    "pauseUpdates": false,
    "online": true,
    "osVersion": "Android 12",
    "outOfDate": true,
    "registerDate": "2023-11-12T10:30:00Z",
    "updating": false,
    "factoryResetStatus": "NONE",
    "firmwareVersion": "Oculus OS 46.0.0.230",
    "configuration": {
      "id": "sFidGmedeQofSBcvRcyn",
      "name": "Training Configuration"
    },
    "tags": [
      {
        "id": "tag_abc123",
        "name": "Lab Devices"
      }
    ],
    "tutorialModeEnabled": false,
    "kioskModeOverride": true,
    "lastSync": "2024-04-20T17:23:12Z",
    "ram": {
      "available": 2147483648,
      "total": 4294967296
    },
    "storage": {
      "available": 15728640000
    },
    "location": {
      "city": "San Francisco",
      "region": "California",
      "country": "US",
      "continent": "North America",
      "timeZone": "America/Los_Angeles",
      "longitude": -122.4194,
      "latitude": 37.7749
    },
    "connectedWifiNetwork": {
      "ssid": "ManageXR-Office"
    },
    "currentForegroundApp": {
      "packageName": "com.my.app",
      "title": "My Training App"
    },
    "controllerData": {
      "controller0": {
        "batteryLevel": 85,
        "version": "v14"
      },
      "controller1": {
        "batteryLevel": 82,
        "version": "v14"
      }
    }
  }
]

GET

organizations

{orgId}

devices

List Devices

curl --request GET \
  --url https://managexrapi.com/organizations/{orgId}/devices \
  --header 'Authorization: Basic <encoded-value>'

[
  {
    "id": "12345678901234",
    "serial": "12345678901234",
    "name": "Training Room 1",
    "mac": "CE:AF:07:47:E0:AE",
    "model": "Quest 2",
    "manufacturer": "Meta",
    "notes": "Mounted in Room 5",
    "batteryLevel": 87,
    "batteryIsCharging": true,
    "pauseUpdates": false,
    "online": true,
    "osVersion": "Android 12",
    "outOfDate": true,
    "registerDate": "2023-11-12T10:30:00Z",
    "updating": false,
    "factoryResetStatus": "NONE",
    "firmwareVersion": "Oculus OS 46.0.0.230",
    "configuration": {
      "id": "sFidGmedeQofSBcvRcyn",
      "name": "Training Configuration"
    },
    "tags": [
      {
        "id": "tag_abc123",
        "name": "Lab Devices"
      }
    ],
    "tutorialModeEnabled": false,
    "kioskModeOverride": true,
    "lastSync": "2024-04-20T17:23:12Z",
    "ram": {
      "available": 2147483648,
      "total": 4294967296
    },
    "storage": {
      "available": 15728640000
    },
    "location": {
      "city": "San Francisco",
      "region": "California",
      "country": "US",
      "continent": "North America",
      "timeZone": "America/Los_Angeles",
      "longitude": -122.4194,
      "latitude": 37.7749
    },
    "connectedWifiNetwork": {
      "ssid": "ManageXR-Office"
    },
    "currentForegroundApp": {
      "packageName": "com.my.app",
      "title": "My Training App"
    },
    "controllerData": {
      "controller0": {
        "batteryLevel": 85,
        "version": "v14"
      },
      "controller1": {
        "batteryLevel": 82,
        "version": "v14"
      }
    }
  }
]

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.

Response

200 - application/json

A list of devices

string

The device ID (serial number)

Example:

"12345678901234"

serial

string

Device serial number

Example:

"12345678901234"

name

string

The device name

Example:

"Training Room 1"

mac

string

MAC address of the device

Example:

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

model

string

The device model

Example:

"Quest 2"

manufacturer

string

The device manufacturer

Example:

"Meta"

notes

string

Optional user-provided notes about the device

Example:

"Mounted in Room 5"

batteryLevel

number

Battery level percentage

Example:

87

batteryIsCharging

boolean

Whether the device is currently charging

Example:

true

pauseUpdates

boolean

Whether updates are paused for this device

Example:

false

online

boolean

Whether the device is currently online

Example:

true

osVersion

string

The OS version running on the device

Example:

"Android 12"

outOfDate

boolean

Whether the device is running outdated software

Example:

true

registerDate

string<date-time>

The date this device was registered with ManageXR

Example:

"2023-11-12T10:30:00Z"

updating

boolean

Whether the device is currently performing an update

Example:

false

factoryResetStatus

string

Status of any pending or active factory reset

Example:

"NONE"

firmwareVersion

string

Firmware version reported by the device

Example:

"Oculus OS 46.0.0.230"

configuration

object

The configuration assigned to this device

Show child attributes

Getting Started

Devices

Configurations

Organizations

List Devices

Authorizations

Path Parameters

Query Parameters

Response