Skip to main content
GET
Get configuration

Authorizations

Authorization
string
header
required

API key based authentication where 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

Example:

"6qwM6FzJE4o708iqTpWc"

name
string

Name of the configuration

Example:

"Trial"

registrationCode
string

Configuration code (formerly known as 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

videos
object[]

(Optional) List of all videos deployed on the configuration

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

Example: