GET
/
v1
/
devices
/
curl --request GET \
  --url https://managexrapi.com/v1/devices/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "data": [
    {
      "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.

Query Parameters

organizationId
string

Unique identifier of the organization. Defaults to the organization associated with the API key if no id supplied.

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

The response is of type object.