GET
/
organizations
/
{orgId}
/
configurations
/
{configurationId}
curl --request GET \
  --url https://managexrapi.com/organizations/{orgId}/configurations/{configurationId} \
  --header 'Authorization: Basic <encoded-value>'
{
  "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
​
id
string

Unique identifier of the configuration

​
name
string

Name of the configuration

​
registrationCode
string

Registration code for the configuration. Learn More

​
deviceCount
number

Number of devices using the configuration

​
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

​
videos
object[]

(Optional) List of all videos deployed on the configuration

​
webxrLinks
object[]

(Optional) List of WebXR Links deployed on the configuration

​
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.

List ConfigurationsList Organizations