Get Configuration

GET

organizations

{orgId}

configurations

{configurationId}

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

Copy
{
  "id": "6qwM6FzJE4o708iqTpWc",
  "name": "Trial",
  "registrationCode": "f7GbHvH",
  "deviceCount": 15,
  "deviceExperience": "HOME_SCREEN",
  "apps": [
    {
      "id": "01b8e51a-15d3-2sd3-a0d8-4c13ff633413",
      "title": "Example App",
      "packageName": "com.example.app",
      "description": "Quest version of my example app",
      "versionCode": 42,
      "versionName": "1.0.0",
      "versionLabel": "Release",
      "apkSize": 1024,
      "obbSize": 1024,
      "categories": [
        "Onboarding",
        "Safety"
      ],
      "hidden": true,
      "forceInstall": false,
      "autoGrantPermissions": true,
      "expirationTimestamp": 1710566400,
      "expirationBehavior": "DISABLE_APP"
    }
  ],
  "videos": [
    {
      "id": "2656f354-9723-43f5-9165-f4b2a8662ab0",
      "title": "Example Video",
      "videoType": "_360",
      "description": "5 minute video of Patagonia",
      "size": 1024,
      "categories": [
        "Field Trips",
        "South America"
      ],
      "hidden": false
    }
  ],
  "webxrLinks": [
    {
      "id": "1Gvlpc3JVGcynBrWSJwI",
      "url": "http://www.thechinaguide.com/destination/great-wall-of-china",
      "title": "Great wall of China",
      "description": "A grand tour of the great wall of China, from the comfort of your seat.",
      "categories": [
        "Field Trips",
        "Asia"
      ],
      "hidden": true
    }
  ],
  "files": [
    {
      "id": "0uZN2kuoQhcZJglgVNTc",
      "path": "/foo/bar/myFile.png",
      "size": 1024
    }
  ],
  "wifiNetworks": [
    {
      "id": "1tZw3kuoOfcZMgbIs8",
      "ssid": "SF_Office_123",
      "nickname": "SF Office wifi main",
      "type": "WPA_ENTERPRISE"
    }
  ],
  "kioskAppId": {
    "available": "10707AB329856"
  }
}

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.

configurationId

string

required

Unique identifier of the configuration

Response

200 - application/json

A configuration object

string

Unique identifier of the configuration

Example:

"6qwM6FzJE4o708iqTpWc"

name

string

Name of the configuration

Example:

"Trial"

registrationCode

string

Registration code for the configuration. Learn More

Example:

"f7GbHvH"

deviceCount

number

Number of devices using the configuration

Example:

15

deviceExperience

enum<string>

Device experience set on the configuration

Available options:

HOME_SCREEN,

KIOSK,

DEFAULT

apps

object[]

(Optional) List of all apps deployed on the configuration

apps.id

string

Unique identifier of the app

Example:

"01b8e51a-15d3-2sd3-a0d8-4c13ff633413"

apps.title

string

Title of the app

Example:

"Example App"

apps.packageName

string

Package name of the app

Example:

"com.example.app"

apps.description

string

Description of the app

Example:

"Quest version of my example app"

apps.versionCode

number

Numeric code of the app version

Example:

42

apps.versionName

string

Name of the app version

Example:

"1.0.0"

apps.versionLabel

string

Label applied to the app version

Example:

"Release"

apps.apkSize

number

Size of the APK file for this app version in bytes

Example:

1024

apps.obbSize

number

(Optional) Size of the OBB file for this app version in bytes

Example:

1024

apps.categories

string[]

(Optional) List of Home Screen categories assigned to the app on ManageXR

Example:

["Onboarding", "Safety"]

apps.hidden

boolean

(Optional) True if the app is hidden on the Home Screen. Learn More

Example:

true

apps.forceInstall

boolean

(Optional) True if Force Install is enabled for the app on this configuration. When true, app updates will uninstall the current version of the app on device before installing the next version. Learn More

Example:

false

apps.autoGrantPermissions

boolean

(Optional) True if Automatically Grant Permissions is enabled for the app on this configuration. When true, the device automatically grants certain device permissions that the app requests. Learn More

Example:

true

apps.expirationTimestamp

number

(Optional) Expiration date of the shared app. Time in millis since 1970. Learn More

Example:

1710566400

apps.expirationBehavior

enum<string>

(Optional) Expiration behavior of the shared app when expirationTimestamp is reached. Learn More

Available options:

NONE,

DISABLE_APP,

DELETE_APP

Example:

"DISABLE_APP"

videos

object[]

(Optional) List of all videos deployed on the configuration

videos.id

string

Unique identifier of the video

Example:

"2656f354-9723-43f5-9165-f4b2a8662ab0"

videos.title

string

Title of the video

Example:

"Example Video"

videos.videoType

enum<string>

Type of video

Available options:

_360,

_180,

_2D

Example:

"_360"

videos.description

string

Description of the video

Example:

"5 minute video of Patagonia"

videos.size

number

Size of the video in bytes

Example:

1024

videos.categories

string[]

(Optional) List of Home Screen categories assigned to the app on ManageXR

Example:

["Field Trips", "South America"]

videos.hidden

boolean

(Optional) True if the video is hidden on the Home Screen. Learn More

Example:

false

webxrLinks

object[]

(Optional) List of WebXR Links deployed on the configuration

webxrLinks.id

string

Unique identifier of the WebXR link

Example:

"1Gvlpc3JVGcynBrWSJwI"

webxrLinks.url

string

Url of the WebXR link

Example:

"http://www.thechinaguide.com/destination/great-wall-of-china"

webxrLinks.title

string

Title of the WebXR link

Example:

"Great wall of China"

webxrLinks.description

string

Description of the WebXR link

Example:

"A grand tour of the great wall of China, from the comfort of your seat."

webxrLinks.categories

string[]

(Optional) List of Home Screen categories assigned to the WebXR link on ManageXR

Example:

["Field Trips", "Asia"]

webxrLinks.hidden

boolean

(Optional) True if the WebXR Link is hidden on the Home Screen. Learn More

Example:

true

files

object[]

(Optional) List of files deployed on the configuration

wifiNetworks

object[]

(Optional) List of wifi networks deployed on the configuration

kioskAppId

string

(Optional) The unique identifier of the Kiosk App, if one is present and the configuration uses deviceExperience = KIOSK.

Example:

{ "available": "10707AB329856" }

List Configurations List Organizations

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

Copy
{
  "id": "6qwM6FzJE4o708iqTpWc",
  "name": "Trial",
  "registrationCode": "f7GbHvH",
  "deviceCount": 15,
  "deviceExperience": "HOME_SCREEN",
  "apps": [
    {
      "id": "01b8e51a-15d3-2sd3-a0d8-4c13ff633413",
      "title": "Example App",
      "packageName": "com.example.app",
      "description": "Quest version of my example app",
      "versionCode": 42,
      "versionName": "1.0.0",
      "versionLabel": "Release",
      "apkSize": 1024,
      "obbSize": 1024,
      "categories": [
        "Onboarding",
        "Safety"
      ],
      "hidden": true,
      "forceInstall": false,
      "autoGrantPermissions": true,
      "expirationTimestamp": 1710566400,
      "expirationBehavior": "DISABLE_APP"
    }
  ],
  "videos": [
    {
      "id": "2656f354-9723-43f5-9165-f4b2a8662ab0",
      "title": "Example Video",
      "videoType": "_360",
      "description": "5 minute video of Patagonia",
      "size": 1024,
      "categories": [
        "Field Trips",
        "South America"
      ],
      "hidden": false
    }
  ],
  "webxrLinks": [
    {
      "id": "1Gvlpc3JVGcynBrWSJwI",
      "url": "http://www.thechinaguide.com/destination/great-wall-of-china",
      "title": "Great wall of China",
      "description": "A grand tour of the great wall of China, from the comfort of your seat.",
      "categories": [
        "Field Trips",
        "Asia"
      ],
      "hidden": true
    }
  ],
  "files": [
    {
      "id": "0uZN2kuoQhcZJglgVNTc",
      "path": "/foo/bar/myFile.png",
      "size": 1024
    }
  ],
  "wifiNetworks": [
    {
      "id": "1tZw3kuoOfcZMgbIs8",
      "ssid": "SF_Office_123",
      "nickname": "SF Office wifi main",
      "type": "WPA_ENTERPRISE"
    }
  ],
  "kioskAppId": {
    "available": "10707AB329856"
  }
}

API Reference

Devices

Configurations

Organizations

Authorizations

Path Parameters

Response