Get a list of player screen layouts

  • Published on Jan 24, 2025
  • 1 minute(s) reading time
Prev Next
Get
/v{version}/ScreenLayouts

Screen layouts are implicitly filtered by user read permission.

Security
API Key
Header parameter nameX-ApiKey

Api Key

API Key
Header parameter nameX-Session-Id

Session Id

Path parameters
version
stringRequired

The requested API version

Default"1.18"
Responses
200

OK

Array of object
object

Screen's layout

Created
string (date-time)

Creation date in UTC

Height
integer (int32)

Height of screen layout in pixels

Id
integer (int32)

Unique ID of screen layout

Modified
string (date-time)

Modification date in UTC

Name
string

Name of screen layout

Type
string

Type of screen layout

Valid values[ "Default", "Interactive", "XHub" ]
Width
integer (int32)

Width of screen layout in pixels

400

Bad request

Expand All
object
ValidationErrors
object
property*
Array of string additionalProperties
string
403

Access denied

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties
500

Unexpected error

Expand All
object
Id
string
Message
string
Type
string
Values
object
property*
object additionalProperties