v1

latestOpenAPI 3.1.02026-07-26189891.1 MB

Screens

Retrieve a screen

Retrieve a specific screen

get/v1/config/screen/{id}

idstring required

A fully detailed screen resource for the matching id.

idstring required

The identifier of this screen.

accountstring

The account this screen belongs to.

titlestring required

The title of this screen.

ratio'3:2' | '4:3' | '5:4' | '16:9' | '16:10' | '21:9' required

The width to height aspect ratio of this screen.

rotate90Degreesboolean required

Whether the screen is rotated 90 degrees. Setting to true effectively swaps the width to height ratio.

background'dark' | 'light' required

The background color to use when viewing the screen.

categoriesstring[]

A list of string categories the screen belongs to.